Record an embedded signup event

POST/v1/waba/signup-event

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

ad_account_idsstring[] | null

Ad account IDs

business_idstring

Business ID

current_stepstring

Current signup step

error_idstring

Error ID if any

error_messagestring

Error message if any

eventstringrequired

Signup event type

min length 1

page_idsstring[] | null

Page IDs

phone_number_idstring

Phone number ID

session_idstring

Session ID

waba_idstring

WABA ID

Responses

201Created

statusstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/waba/signup-event" \
  -H "Content-Type: application/json" \
  -d '{
  "ad_account_ids": [
    "string"
  ],
  "business_id": "string",
  "current_step": "string",
  "error_id": "string",
  "error_message": "string",
  "event": "string",
  "page_ids": [
    "string"
  ],
  "phone_number_id": "string",
  "session_id": "string",
  "waba_id": "string"
}'

const response = await fetch("/v1/waba/signup-event", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "ad_account_ids": [
    "string"
  ],
  "business_id": "string",
  "current_step": "string",
  "error_id": "string",
  "error_message": "string",
  "event": "string",
  "page_ids": [
    "string"
  ],
  "phone_number_id": "string",
  "session_id": "string",
  "waba_id": "string"
})
});

import requests

response = requests.post(
    "/v1/waba/signup-event",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "ad_account_ids": [
    "string"
  ],
  "business_id": "string",
  "current_step": "string",
  "error_id": "string",
  "error_message": "string",
  "event": "string",
  "page_ids": [
    "string"
  ],
  "phone_number_id": "string",
  "session_id": "string",
  "waba_id": "string"
},
)

Response

{
  "status": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}