Skip to content

Connect WhatsApp

Request a verification code

Asks Meta to send a verification code to the business number. Enter the code with the verify-code endpoint.

POST/api/v1/channel/{id}/request-code
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Path parameters

  • iduuidrequired

    Channel id (from channels[].id).

    Example
    b4c5d6e7-f809-41a2-b3c4-d5e6f7081920

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Body

application/json
  • code_methodenumoptional

    SMS or VOICE (case-insensitive).

    Default
    SMS
    Example
    SMS

Response

200 OKapplication/json

  • okboolean

    Always true.

  • messagestring

    Next step for the user.

Status codes

  • 200OK. Meta accepted the request.
  • 400Bad request. code_method must be SMS or VOICE, an invalid channel id, or Meta did not send a code.
  • 401Unauthorized. No signed-in session (unauthorized).
  • 403Forbidden. API keys can never call this endpoint (API keys cannot administer workspaces). A signed-in user who is not an owner or admin gets admin required; a user who is not a member of the workspace gets forbidden.
  • 404Not found. No Cloud API channel with this id in the workspace.
  • 502Bad gateway. Meta returned a server error. Errors coming from Meta add meta_code, meta_subcode and meta_title when Meta provides them.