client

request pairing code

Request a pairing code for phone number registration. To prevent abuse and ensure system stability, pairing code requests are limited to 2 per minute. Multiple rapid requests may indicate automated abuse attempts.

post/instances/{id}/client/action/request-pairing-code

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/action/request-pairing-code
Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

phoneNumberstring required

Phone number in international format without symbols (e.g. 50664083362)

showNotificationboolean

Whether to show notification when pairing code is received

Example request

{
  "phoneNumber": "50664083362"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully retrieved pairing code.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "data": {
      "pairingCode": "ABC-123"
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/request-pairing-code"
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.