whatsapp-cloud

Register a WhatsApp Cloud number

Exchanges an Embedded Signup code and registers the WhatsApp Business Account in the background. Returns 202 with a task_id; poll the registration task until its status is completed or failed. The business is taken from the business-id header rather than the URL; the path-scoped form of this operation is deprecated.

post/api/v1/businesses/whatsapp_cloud/register

Request

  • Base URL: https://api.izap.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.izap.ai/api/v1/businesses/whatsapp_cloud/register
  • Auth: HTTP bearer

Headers

business-idstring nullable required

UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.

Request body

codestring required
waba_business_idstring nullable
phone_number_idstring nullable
waba_idstring nullable
redirect_uristring nullable

Response

Successful Response

task_idstring uuid required
status'pending' | 'processing' | 'completed' | 'failed'

Lifecycle of an async registration job.

PENDING is created by POST /auth/register before the worker picks it up. PROCESSING means the dramatiq actor is running. Terminal states are COMPLETED (account ready) and FAILED (see error_code / error_detail).

Changes

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