Account Sharing

Endpoints for account sharing features and configurations

Onboard new number using account sharing feature

post

This endpoint allows partners to onboard a number that is shared with solution. One of waba_business_id or client_id must be specified.

Note: This endpoint is primarily for partners hosting embedded signup.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

solution_idstringRequired

Meta's partner solution id

Example: 23475642367

waba_external_idstringRequired

Meta's Whatsapp business account (WABA) id

Example: 31893466565234

waba_business_idstringOptional

Meta's business id which is owning WABA

Example: 89732461622213

client_idstringOptional

Client ID that owns the number

Example: exampleCL

tierstring · enum · nullableOptional

Tier that should be used for the client channel.

Example: basicPossible values:

Responses

200

Successful response

application/json

solution_idstringRequired

Meta's partner solution id

Example: 23475642367

waba_external_idstringRequired

Meta's Whatsapp business account (WABA) id

Example: 31893466565234

waba_business_idstringOptional

Meta's business id which is owning WABA

Example: 89732461622213

client_idstringOptional

Client ID that owns the number

Example: exampleCL

tierstring · enum · nullableOptional

Tier that should be used for the client channel.

Example: basicPossible values:

messagestringOptionalExample: Success. Please wait, your number is onboarding.

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/account_sharing/numbers

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/account_sharing/numbers HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "solution_id": "23475642367",
  "waba_external_id": "31893466565234",
  "waba_business_id": "89732461622213",
  "client_id": "exampleCL",
  "tier": "basic"
}

{
  "solution_id": "23475642367",
  "waba_external_id": "31893466565234",
  "waba_business_id": "89732461622213",
  "client_id": "exampleCL",
  "tier": "basic",
  "message": "Success. Please wait, your number is onboarding."
}

Signup new user and create a client entity.

post

This endpoint allows partners to signup a new user and create an empty client entity for the user.

Note: This endpoint is primarily for partners hosting embedded signup.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

namestringRequired

Name of the client organisation.

Example: Company LLC

emailstring · emailRequired

Email address of the client user.

Example: [email protected]

user_namestringOptional

Name of the client user.

Example: John Doe

send_client_emailbooleanOptional

Send invitation email to a client user

Default: true

is_initial_onboarding_clientbooleanOptional

Mark this client as the initial onboarding client for auto-assigning new partner users

Default: false

Responses

200

Successful response

application/json

modified_atstringOptional

Time when the entity was last modified

Example: 2023-01-02T12:00:00Z

created_atstringOptional

Time when the entity was created

Example: 2023-01-01T12:00:00Z

idstringOptional

Client ID

Example: exampleCL

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/account_sharing/clients

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/account_sharing/clients HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "name": "Company LLC",
  "email": "[email protected]",
  "user_name": "John Doe",
  "send_client_email": true,
  "is_initial_onboarding_client": false
}

{
  "modified_by": {
    "user_id": "user123U",
    "user_name": "John Doe"
  },
  "created_by": {
    "user_id": "user123U",
    "user_name": "John Doe"
  },
  "modified_at": "2023-01-02T12:00:00Z",
  "created_at": "2023-01-01T12:00:00Z",
  "id": "exampleCL"
}