Skip to main content
POST
/
v1
/
organization
/
whatsapp
/
business-profiles
/
claim
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/organization/whatsapp/business-profiles/claim \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attemptId": "wss_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
}
'
{
  "id": "wabp_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "organizationId": "<string>",
  "metaWabaId": "<string>",
  "metaBusinessId": "<string>",
  "businessName": "Acme Corp",
  "tokenExpiresAt": "2023-11-07T05:31:56Z",
  "onboardingCompletedAt": "2023-11-07T05:31:56Z",
  "reviewDecidedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "phoneNumbers": [
    {
      "id": "<string>",
      "displayPhoneNumber": "+15551234567",
      "metaPhoneNumberId": "<string>",
      "verified": true,
      "qualityRating": "GREEN"
    }
  ],
  "isTestProfile": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.buildwithchirp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Body

application/json
​
attemptId
string
required

The ID of the recovered signup attempt to claim

Pattern: ^wss_[a-zA-Z0-9]+$
Example:

"wss_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Business profile created successfully from claimed attempt

​
id
string
required

WhatsApp Business Profile ID

Pattern: ^wabp_[a-zA-Z0-9]+$
Example:

"wabp_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
organizationId
string
required
​
metaWabaId
string
required

Meta's WhatsApp Business Account ID

​
metaBusinessId
string | null
required

Meta's Business Portfolio ID

​
businessName
string | null
required

Business name from Meta

Example:

"Acme Corp"

​
tokenExpiresAt
string<date-time> | null
required

When the access token expires (null = never)

​
onboardingCompletedAt
string<date-time> | null
required

When onboarding was completed

​
reviewDecision
enum<string> | null
required

Latest WABA policy review outcome from Meta's account_review_update webhook

Available options:
APPROVED,
REJECTED,
PENDING,
DEFERRED
​
reviewDecidedAt
string<date-time> | null
required

When Meta last decided the WABA review

​
createdAt
string<date-time>
required
​
phoneNumbers
object[]
required
​
isTestProfile
boolean
required

Whether this is a test profile (for test mode separation)