Client Management

Endpoints for managing clients and their configurations

Retrieve list of clients

get

This endpoint allows partners to get the list of clients.

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

Query parameters

sortstring · enumOptional

Sort results by client fields

Example: namePossible values:

offsetintegerOptional

Number of results to skip

Example: 10

limitintegerOptional

Maximum number of results to return

Example: 10

Responses

200

Successful response

application/json

limitintegerOptional

Maximum number of results to return

Example: 10

offsetintegerOptional

Number of results to skip

Example: 0

sortstring[]Optional

Sort results by client fields

Example: ["name","-created_at"]

totalintegerOptional

Total number of results

Example: 100

countintegerOptional

Number of results returned

Example: 8

400

Wrong payload

application/json

404

Not found

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/clients HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "limit": 10,
  "offset": 0,
  "sort": [
    "name",
    "-created_at"
  ],
  "filters": {
    "name": {
      "like": "LLC"
    }
  },
  "total": 100,
  "count": 8,
  "clients": [
    {
      "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",
      "name": "Company",
      "status": "active",
      "contact_info": {
        "email": "[email protected]",
        "webpage_url": "https://company.com",
        "phone": "[phone]",
        "language": "en",
        "country": "US",
        "street_name": "13th Street",
        "city": "New York",
        "full_name": "John Doe",
        "zip_code": "12345"
      },
      "contact_user": {
        "email": "[email protected]",
        "phone": "[phone]",
        "name": "John Doe"
      },
      "partner_payload": "This client account is created for a specific purpose",
      "max_channels": 10,
      "fb_business_id": "348728345238956"
    }
  ]
}

Update a client

patch

This endpoint allows partners to update client onboarding settings.

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

client_idstringRequired

The ID of the client.

Example: exampleCL

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

partner_payloadstringOptional

Optional field that partner can use to configure something on their logic or distinguish clients based on different values

Example: This client account is created for a specific purpose

max_channelsintegerOptional

Maximum number of channels/numbers that the client can have

Example: 10

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

namestringOptional

Client name

Example: Company

statusstringOptional

Client status

Example: active

organisationstringOptionalDeprecated

[Deprecated]

partner_payloadstringOptional

Optional field that partner can use to configure something on their logic or distinguish clients based on different values

Example: This client account is created for a specific purpose

max_channelsintegerOptional

Maximum number of channels/numbers that the client can have

Example: 10

suspiciousbooleanOptionalDeprecated

[Internal Field]

enabled_for_chat_supportbooleanOptionalDeprecated

[Internal Field]

fb_business_idstring · nullableOptional

Business ID of the first whatsapp business account that this client used to onboard a number

Default: nullExample: 348728345238956

400

Wrong payload

application/json

404

Not found

application/json

patch

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

HTTPcURLJavaScriptPython

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

{
  "partner_payload": "This client account is created for a specific purpose",
  "max_channels": 10
}

{
  "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",
  "name": "Company",
  "status": "active",
  "contact_info": {
    "email": "[email protected]",
    "webpage_url": "https://company.com",
    "phone": "[phone]",
    "language": "en",
    "country": "US",
    "street_name": "13th Street",
    "city": "New York",
    "full_name": "John Doe",
    "zip_code": "12345"
  },
  "contact_user": {
    "email": "[email protected]",
    "phone": "[phone]",
    "name": "John Doe"
  },
  "partner_payload": "This client account is created for a specific purpose",
  "max_channels": 10,
  "fb_business_id": "348728345238956"
}

Retrieve Shared Client Numbers

get

This endpoint retrieves the list of channels that clients shared with the partner

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

client_idstringRequired

The ID of the client.

Example: exampleCL

partner_idstringRequired

The ID of the partner.

Example: examplePA

Responses

200

Successful response

application/json

statusstring · enumOptional

Current status of the channel. Possible values are:

• created: The channel is created and process for onboarding is started.
• unverified: The channel is submitted to Meta and waiting for them to verify the display name.
• verified: The channel display name is verified by Meta.
• ready: The channel onboarding is completed and can be used for sending and receiving messages.
• transferred: The channel is transferred to another BSP and 360dialog does not have access to it.
• modified: [deprecated] When a channel name is updated.
• imported: [deprecated]
• new_name_requested: A new display name is requested for the channel and waiting for Meta's approval.
• certificate_declined: The channel display name is rejected by Meta.
• consents_signed: [deprecated]
• error: Channel setup is failed for any reason and channel can not be used for messaging.
• porting_ready: [deprecated]
• ready_for_migration: [deprecated] A new channel is created to migrate a phone number from another BSP to 360dialog.
• waiting_for_migration_code: [deprecated] Channel migration is initiated and next step is requesting a migration code from Meta.
• migration_code_requested: [deprecated] Channel migration code is requested from Meta.
• migration_verified: [deprecated] Channel migration is verified.
• unregistered: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.
• removed: 360dialog does not have access to the number on Meta.

Example: readyPossible values:

idstringOptional

Channel ID

Example: exampleCH

cancelled_atstring · nullableOptional

Channel cancellation datetime

Example: 2024-08-01T00:00:00Z

client_idstringOptional

Client ID that is the owner of the channel

Example: exampleCL

created_atstringOptional

Channel creation datetime

Example: 2024-08-01T00:00:00Z

current_limitstringOptional

Meta's number current limit, can be NA or from TIER_50 to TIER_UNLIMITED

Example: TIER_1K

current_quality_ratingstringOptional

Meta's number current quality rating, can be NA, Low, Medium or High

Example: Medium

current_quality_update_eventstring · nullableOptional

Meta's Last number quality update event

Example: flagged

is_obabooleanOptional

Indicates if business phone number is an Meta's Official Business Account.

hub_statusstringOptionalDeprecated

[Deprecated] Current hub status of the channel. Use availability_status as the source of truth. Possible values are:

• live: Number is live and connected and messaging is available.
• sandbox: [deprecated] Number is available in sandbox environment.
• done: [deprecated] Same as live.
• pending: [deprecated] [on-prem] An on-prem stack is being setup.
• draft: Stack is being setup for the number.
• pending_deletion: Number will be terminated soon.
• unregistered: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.
• unknown: Unknown status. Needs to be checked by support.

Example: live

availability_statusstring · enum · nullableOptional

Current availability status of the channel. This is the unified source of truth for channel availability. Possible values are:

• setting_up: Channel is being set up
• ready: Channel is ready and available for messaging
• error: Channel has an error and is not available for messaging

Example: readyPossible values:

terminated_atstring · nullableOptional

Channel termination datetime

Example: 2024-09-01T00:00:00Z

account_modestringOptionalDeprecated

[Deprecated] Can be live or sandbox

Example: live

billing_started_atstring · nullableOptionalDeprecated

[Deprecated]

Example: 2024-01-01T01:00:00Z

is_migratedbooleanOptionalDeprecated

[Internal Field]

has_inboxboolean · nullableOptionalDeprecated

[Internal Field]

Default: null

versionintegerOptionalDeprecated

[Deprecated]

Example: 2

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/clients/{client_id}/shared_client_numbers

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/clients/{client_id}/shared_client_numbers HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "status": "ready",
    "id": "exampleCH",
    "cancelled_at": "2024-08-01T00:00:00Z",
    "client_id": "exampleCL",
    "created_at": "2024-08-01T00:00:00Z",
    "current_limit": "TIER_1K",
    "current_quality_rating": "Medium",
    "current_quality_update_event": "flagged",
    "is_oba": true,
    "availability_status": "ready",
    "settings": {
      "tier": "premium",
      "data_localization_region": "US"
    },
    "setup_info": {
      "phone_name": "Company Name",
      "phone_number": "[phone]",
      "certificate": "asdj32890skljandl_amkl4444_lkjjlka993_aadasdasd",
      "default_language": "en",
      "ivr": false,
      "verification_method": "voice",
      "was_in_use": false
    },
    "terminated_at": "2024-09-01T00:00:00Z"
  }
]