KNknotapi

Create Knot Zero Links (Batch)

Changed on

Create Knot Zero links for up to 10,000 users in one request.

post/zero-link/batch/create

Request

  • Base URL
    https://development.knotapi.com
  • URL
    https://development.knotapi.com/zero-link/batch/create
  • Auth
    HTTP basic

Request body

type'card_switcher' required

Product to associate the link with.

Example request

{
  "type": "card_switcher",
  "users": [
    {
      "phone_number": "+12025550123",
      "external_user_id": "123abc",
      "card_id": "81n9al10a0ayn13"
    }
  ]
}

Response

Successful request. Results are returned in the same order as users in the request. A user that fails validation returns an error instead of a link and doesn't fail the rest of the request.

Example response

{
  "links": [
    {
      "external_user_id": "123abc",
      "card_id": "81n9al10a0ayn13",
      "link": "https://clip.knotapi.com/switch?token=example_knot_zero_token_1xxxxxxxxxxxxxxxxxx",
      "token": "example_knot_zero_token_1xxxxxxxxxxxxxxxxxx",
      "error": {
        "error_type": "INVALID_REQUEST",
        "error_code": "INVALID_FIELD",
        "error_message": "The phone number format is invalid."
      }
    }
  ]
}

Changes