API Reference

This page describes available endpoints, required authentication, request parameters, response formats, and error codes.

For all get requests, see filter options.

Get Clients

Retrieve all Clients associated with a specific Partner account.

GET https://hub.360dialog.io/api/v2/partners/{partner_id}/clients

Request example

curl --request GET
--url https://hub.360dialog.io/api/v2/partners/partner_id/clients
--header 'Authorization: '
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.

Example: examplePA

Query Parameters

Name

Type

Description

filters

string

A JSON object of params and their expected values

limit

string

Objects limit to return in the response

offset

string

Show the results starting from an offset

sort

string

Use minus - symbol for descending sorting

Headers

Name

Type

Description

Content-Type

String

application/json

{
  "count": 0,   >> Means Count of clients available in this Partner Hub
  "filters": {},
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0,
  "total": 0,
  "clients": [
    {
      "id": "string",   >> This Client's ID
      "name": "string",
      "status": "active",   >> This Client's status: if active or not
      "organisation": "string",   >> This Client's company name
      "meta_info": {   >> Information submitted during the creation of the WABA
        "business_vertical": "string",
        "timezone": "string",
        "about": "string",
        "business_description": "string",
        "use_case": "string"
      },
      "contact_info": {   >> This Client's contact information
        "webpage_url": "string",
        "phone": "string",
        "language": "string",
        "country": "string",
        "street_name": "string",
        "city": "string",
        "email": "string",
        "full_name": "string",
        "zip_code": "string"
      },
      "contact_user": {   >> User information registered under this Client Hub
        "phone": "string",
        "email": "string",
        "name": "string"
      },
      "partner_payload": "string",
      "created_at": "string",   >> When was the Client Hub created
      "created_by": {   >> Who created the Client Hub
        "user_id": "string",
        "user_name": "string"
      },
      "modified_at": "string",   >> When was the Client Hub last modified
      "modified_by": {   >> Who last modified this Client Hub
        "user_id": "string",
        "user_name": "string"
      },
      "max_channels": 2   >> Maximum number of channels allowed in this Client Hub (2 is default)
    }
  ]
}

{
  "meta": {
    "success": false,
    "http_code": 400,
    "developer_message": "There was an error with your request",
    "details": [
      "string"
    ],
    "error_data": {
      "code": "string",
      "message": "string",
      "real_message": "string",
      "status": 0
    }
  }
}

Get Client Balance

WhatsApp conversation usage is always associated with a 360dialog Client Hub account, identified by the client_id, regardless of the number of channels.

GET https://hub.360dialog.io/api/v2/partners/{{partner_id}}/clients/{{client_id}}/info/balance

Returns the usage and balance associated with a specific Client.

Rate limit: 5 requests per 30 seconds.

Request example

curl --request GET
--url https://hub.360dialog.io/api/v2/partners/{partner_id}/clients/{client_id}/info/balance
--header 'Authorization: '
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

client_id*

string

The ID of the client.

Example: exampleCL

partner_id*

string

The ID of the partner.

Example: examplePA

Query Parameters

Name

Type

Description

end_date

UNIX Timestamp

The end date in UNIX Timestamp (UTC). Returned data will be equal to or older than the specified date.

Example: 1672531200

start_date

UNIX Timestamp

The start date in UNIX Timestamp (UTC). Returned data will be equal to or newer than the specified date.

Example: 1672531200

granularity

string

The granularity by which you would like to retrieve the analytics. Supported Options: DAY , MONTH

Defaults with MONTH if no value is provided in the request.

The balance field is only relevant for clients who are registered with direct payment. When a client is partner-paid, the balance field will return 0.

usage: The array "usage" provides a breakdown of the channel's usage in different categories. These categories may include authentication, marketing, service, utility. Each category within the array includes details such as paid quantity, price, and quantity.

This allows you to analyze the usage patterns and associated costs for different aspects of the channel's messaging services.

{
        "balance": 50.00,  >> Total balance for this Client Hub. Returns 0 if the Client is Partner-paid.
        "currency": "eur", >> Currency: EUR
        "last_renewal": {  >> Information about the last renewal
          "date": "2023-08-01T00:00:00Z,
          "amount": 20.00
        },
        "bi_price_for_currency_and_client_country": 0.2,
        "ui_price_for_currency_and_client_country": 0.02,
        "estimated_template_cost": 0.03, >> Estimated cost per conversation
        "granularity": "day", >> The granularity by which you retrieved the analytics
        "usage": [    >> Usage details
          {
            "authentication_paid_quantity": 0,
            "authentication_price": 0.0,
            "authentication_quantity": 0,
            "marketing_paid_quantity": 0,
            "marketing_price": 0.0,
            "marketing_quantity": 0,
            "service_paid_quantity": 0,
            "service_price": 0.0,
            "service_quantity": 0,
            "utility_paid_quantity": 0,
            "utility_price": 0.0,
            "utility_quantity": 0,
            "business_initiated_paid_quantity": 5,
            "business_initiated_price": 1.0,
            "business_initiated_quantity": 5,
            "free_entry_point": 0,
            "free_quantity": 0,
            "free_tier": 0,
            "paid_quantity": 5,
            "period_date": "2023-08-10T00:00:00Z",
            "quantity": 5,
            "total_price": 1.0,
            "user_initiated_paid_quantity": 0,
            "user_initiated_price": 0.00,
            "user_initiated_quantity": 0
          },
          {
            "authentication_paid_quantity": 0,
            "authentication_price": 0.0,
            "authentication_quantity": 0,
            "marketing_paid_quantity": 0,
            "marketing_price": 0.0,
            "marketing_quantity": 0,
            "service_paid_quantity": 0,
            "service_price": 0.0,
            "service_quantity": 0,
            "utility_paid_quantity": 0,
            "utility_price": 0.0,
            "utility_quantity": 0,
            "business_initiated_paid_quantity": 0,
            "business_initiated_price": 0,
            "business_initiated_quantity": 0,
            "free_entry_point": 0,
            "free_quantity": 0,
            "free_tier": 0,
            "paid_quantity": 5,
            "period_date": "2023-08-11T00:00:00Z",
            "quantity": 5,
            "total_price": 0.05,
            "user_initiated_paid_quantity": 5,
            "user_initiated_price": 0.05,
            "user_initiated_quantity": 5
          }
        ]
      }

{
  "meta": {
    "success": false,
    "http_code": 400,
    "developer_message": "There was an error with your request",
    "details": [
      "string"
    ],
    "error_data": {
      "code": "string",
      "message": "string",
      "real_message": "string",
      "status": 0
    }
  }
}

Get Channels

GET https://hub.360dialog.io/api/v2/partners/{{partner_id}}/channels

Returns all channels associated with a specific Partner ID.

Request example

curl --request GET
--url https://hub.360dialog.io/api/v2/partners/partner_id/channels
--header 'Authorization: '
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.

Example: examplePA

Query Parameters

Name

Type

Description

filters

string

A JSON object of params and their expected values. See Filter Options.

limit

string

Objects limit to return in the response

offset

string

Show the results starting from an offset

sort

string

Use minus - symbol for descending sorting

{
    "count": 1,
    "filters": "string",
    "limit": 1000,
    "offset": 0,
    "partner_channels": [ //List of channels associated with a Partner account
        {
            "account_mode": "live", //Indicates if the account is ready to be used
            "billing_started_at": "2000-01-01T10:00:00Z", //When billing started for this channel
            "cancelled_at": null, //When was the channel cancelled
            "client": { //Client information associated to this channel
                "contact_info": {
                    "country": "string", 
                    "email": "string",
                    "street_name": "string"
                },
                "id": "string",
                "name": "string",
                "partner_payload": null //Partner metadata if existent
            },
            "client_id": "string", //Client Hub ID that owns this channel
            "created_at": "2024-01-10T09:59:19Z",
            "current_limit": "TIER_0.25K",//Current Messaging Limit of the bussines portfolio
            "current_quality_rating": "High", //Current Quality Rating of this channel
            "has_inbox": false, //Deprecated. Do not consider
            "availability_status": "ready", //Status of the account. Options are "ready", "setting_up", "error" 
            "id": "string", //Specific Channel ID
            "integration": {
                "app_id": "138219",
                "enabled": true,
                "hosting_platform_type": "meta_cloud_api",//Type of hosting platform (meta_cloud_api or 360_hosting
                "state": "running"
            },
            "is_migrated": false,
            "is_oba": false, 
            "settings": {
                "data_localization_region": "DE", //Default data localization for this channel - "null" can be considered as US, Cloud API default hosting location
                "tier": "regular"
            },
            "setup_info": {
                "phone_name": "string", //Display Name registered in this channel
                "phone_number": "string" //Phone number registered in this channel
            },
            "status": "ready",>> 
            "terminated_at": null, //When was the channel terminated
            "version": 2,
            "waba_account": {
                "external_id": "string",
                "fb_account_status": "string", //Status of the Meta Business Manager verification
                "fb_business_id": "string",
                "id": "string",
                "namespace": "string",
                "on_behalf_of_business_info": {
                    "id": "string",
                    "name": "string",
                    "status": "approved",
                    "type": "string"
                }
            }
        }
    ],
    "sort": [
        "id"
    ],
    "total": 0
}

{
  "meta": {
    "success": false,
    "http_code": 400,
    "developer_message": "There was an error with your request",
    "details": [
      "string"
    ],
    "error_data": {
      "code": "string",
      "message": "string",
      "real_message": "string",
      "status": 0
    }
  }
}

Get Managed Numbers

Retrieve the channels or phone numbers associated with a specific Client account that can be managed generate API KEY

GET https://hub.360dialog.io/api/v2/partners/{partner_id}/clients/{client_id}/shared_client_numbers

Request Example:

curl --request GET
--url https://hub.360dialog.io/api/v2/partners/partner_id/clients/client_id/shared_client_numbers
--header 'Accept: application/json'
--header 'Authorization: Bearer 123'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.

Example: examplePA

client_id*

string

The ID of the client.

Example: exampleCL

[
    {
        "account_mode": string,
        "billing_started_at": string,
        "cancelled_at": string,
        "client_id": string,
        "created_at": string,
        "current_limit": string,
        "current_quality_rating": string,
        "current_quality_update_event": string,
        "availability_status": string,
        "id": string,
        "is_migrated": string,
        "is_oba": string,
        "settings": {},
        "setup_info": {
            "phone_name": string,
            "phone_number": string
        },
        "status": string,
        "terminated_at": string,
        "version": 2
    }
]

Set Partner Webhook URL

POST https://hub.360dialog.io/api/v2/partners/{partner_id}/webhook_url

Request example

curl --request POST
--url https://hub.360dialog.io/api/v2/partners/partner_id/webhook_url
--header 'Authorization: '
--header 'Content-Type: application/json'
--data '{ "webhook_url": "https://example.com/webhook" }'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.Example: examplePA

Request Body

Name

Type

Description

webhook_url*

string

URL of the webhook resource

{
  "webhook_url": "string",
  "brand_name": null,
  "id": "string",
  "logo_url": null,
  "onboarding_deeplink_add_params": true,
  "payment_plan": {},
  "payment_required": true
}

Once the Webhook URL is configured, events related to WABAs and channels associated with the specific Partner account should start to arrive. Browse all webhook events here

Get Partner Webhook URL

GET https://hub.360dialog.io/api/v2/partners/{partner_id}/webhook_url

Request example

curl --request GET
--url https://hub.360dialog.io/api/v2/partners/partner_id/webhook_url
--header 'Authorization: '
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.Example: examplePA

{
  "webhook_url": "string"
}

Set Redirect URL

PATCH https://hub.360dialog.io/api/v2/partners/{partner_id}

The Redirect URL defines where a client is sent after completing the Integrated Onboarding flow. Setting a Redirect URL is required to use Integrated Onboarding.

Request example

curl --request PATCH
--url https://hub.360dialog.io/api/v2/partners/partner_id
--header 'Authorization: '
--header 'Content-Type: application/json'
--data '{ "webhook_url": "string", "partner_redirect_url": "string" }'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.Example: examplePA

Request Body

Name

Type

Description

webhook_url*

string

Partner webhook URL

partner_redirect_url*

string

The Redirect URL you will use

{
  "webhook_url": "string",
  "partner_redirect_url": "string",
  "brand_name": null,
  "id": "string",
  "logo_url": null,
  "onboarding_deeplink_add_params": true,
  "payment_plan": {},
  "payment_required": true
}

Get Partner Info

GET https://hub.360dialog.io/api/v2/partners/{partner_id}

Request example

curl --request GET
--url https://hub.360dialog.io/api/v2/partners/partner_id
--header 'Authorization: '
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.Example: examplePA

{
    "allow_client_to_add_phone_no": true, 
    "billing_system": "string", //Indicates the type of partner payment
    "blocked_new_submission": false,
    "brand_name": "string", //Name currently set for this Partner Hub
    "country": "US",
    "id": "string", //Partner ID
    "logo_url": "string", //Logo currently set for this Partner Hub
    "onboarding_deeplink_add_params": false,
    "partner_redirect_url": "https://360dialog.com", //Redirect URL currently set for this Partner Hub
    "payment_plan": {},
    "payment_required": false,
    "settings": { //Tech Provider Information
        "account_sharing": {
            "business_manager_id": "string", 
            "solution_id": "string"
        },
        "default_data_localization_region": "DE", //Default data storage for this Partner Hub
        "partner_change_request": {
            "auto_approve": false 
        },
        "standard_tiered_pricing_enabled": true
    },
    "webhook_url": "string" //Webhook URL currently set for this Partner Hub
}

Create API Key

POST https://hub.360dialog.io/api/v2/partners/{partner_id}/channels/{channel_id}/api_keys

Create an API KEY for a specific channel.

Request example

curl --request POST
--url https://hub.360dialog.io/api/v2/partners/partner_id/channels/channel_id/api_keys
--header 'Authorization: '
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

channel_id*

String

The ID of the channel. Example: exampleCH

partner_id*

String

The ID of the partner.

Example: examplePA

{
  "id": "string",
  "address": "string",
  "api_key": "string", 
  "app_id": "string"
}

See Partner Permissions.

Update Max Channels

PATCH https://hub.360dialog.io/api/v2/partners/{{partner_id}}/clients/{{client_id}}

By default, a 360dialog Client can have up to 10 channels. This limit can be increased or decreased using the Max Channel endpoint.

This endpoint updates the maximum number of channels allowed for a specific client by setting the max_channels property in the request payload.

Request example

curl --request PATCH
--url https://hub.360dialog.io/api/v2/partners/partner_id/clients/client_id
--header 'Authorization: '
--header 'Content-Type: application/json'
--data '{ "partner_payload": "", "max_channels": 42 }'

Path Parameters

Name

Type

Description

client_id*

string

The ID of the client.

Example: exampleCL

partner_id*

string

The ID of the partner.

Example: examplePA

Request Body

Name

Type

Description

partner_payload

string

Can be requested with the Get list of clients associated to your Partner Hub endpoint

max_channels

integer

Defines how many channels a Client can create.

{
  "id": "string",
  "name": "string",
  "status": "active",
  "organisation": "string",
  "meta_info": {
    "business_vertical": "string",
    "timezone": "string",
    "about": "string",
    "business_description": "string",
    "use_case": "string"
  },
  "contact_info": {
    "webpage_url": "string",
    "phone": "string",
    "language": "string",
    "country": "string",
    "street_name": "string",
    "city": "string",
    "email": "string",
    "full_name": "string",
    "zip_code": "string"
  },
  "contact_user": {
    "phone": "string",
    "email": "string",
    "name": "string"
  },
  "partner_payload": "string",
  "created_at": "string",
  "created_by": {
    "user_id": "string",
    "user_name": "string"
  },
  "modified_at": "string",
  "modified_by": {
    "user_id": "string",
    "user_name": "string"
  },
  "max_channels": 0
}

Update Display Name

PUT {base_url}/partners/{partner_id}/clients/{client_id}/channels/{channel_id}

This endpoint supports updating a phone number's display name by proxying the request to Meta's API.

Example Request

curl --request PUT \
  --url https://hub.360dialog.io/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My New Display Name"
}'

Headers

Name

Value

Content-Type

application/json

Path Parameters

Name

Type

Description

client_id*

string

The ID of the client.

Example: exampleCL

partner_id*

string

The ID of the partner.

Example: examplePA

Body

Name

Type

Description

name

string

New display name

Response

{
  "meta": {
    "developer_message": "Channel successfully updated.",
    "http_code": 200,
    "success": true
  },
  "status_code": 200
}

Cancel Subscription

POST https://hub.360dialog.io/api/v2/partners/{{partner_id}}/clients/{{client_id}}/channels/{{channel_id}}/control/cancellation_request

Cancels the subscription for a specific channel.

Once requested, subscription charges will be stopped, and the client will be able to pay 360dialog directly if desired. The client will receive an automated email notification informing them of this action. The cancellation terms will apply.

Example Request

curl --request POST
--url https://hub.360dialog.io/api/v2/partners/partner_id/clients/client_id/channels/channel_id/control/cancellation_request
--header 'Accept: application/json'
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

channel_id*

String

The ID of the channel.

Example: exampleCH

client_id*

String

The ID of the client.

Example: exampleCL

parter_id*

String

The ID of the partner.

Example: examplePA

{
  "id": "string",
  "client_id": "string",
  "account_mode": "string",
  "billing_started_at": "string",
  "terminated_at": "string",
  "status": "string",
  "has_inbox": true,
  "is_oba": true,
  "current_limit": "string",
  "current_quality_rating": "string",
  "client": {
    "id": "string",
    "name": "string",
    "contact_info": {
      "webpage_url": "string",
      "phone": "string",
      "language": "string",
      "country": "string",
      "street_name": "string",
      "city": "string",
      "email": "string",
      "full_name": "string",
      "zip_code": "string"
    }
  },
  "setup_info": {
    "phone_number": "string",
    "phone_name": "string",
    "was_in_use": true,
    "ivr": true,
    "verification_method": "string",
    "certificate": "string",
    "new_name_status": "string",
    "default_language": "string",
    "has_integration_layer": true,
    "error": "string",
    "configuration_type": "string",
    "region": "string",
    "shards_number": 0
  },
  "waba_account": {
    "id": "string",
    "fb_account_status": "string",
    "on_behalf_of_business_info": {
      "id": "string",
      "name": "string",
      "status": "string",
      "type": "string"
    }
  },
  "integration": {
    "enabled": true
  },
  "availability_status": "string"
}

{
  "meta": {
    "success": false,
    "http_code": 400,
    "developer_message": "There was an error with your request",
    "details": [
      "string"
    ],
    "error_data": {
      "code": "string",
      "message": "string",
      "real_message": "string",
      "status": 0
    }
  }
}

Reactivate channel

POST https://hub.360dialog.io/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/reactivate

This endpoint allows Partners to revoke a previously requested cancellation for a specific channel, restoring it to an active state if the channel is still eligible. Once a channel and its integration are permanently deleted (30+ days after termination), reactivation is no longer possible, and the number must be onboarded again.

Requirements:

Only available for clients under the partner-paid payment model.
The number must be registered to the same WhatsApp Business Account (WABA).
The channel has been cancelled but not deleted.

The API key and number webhook URL remain unchanged; no reconfiguration is required.

POST https://hub.360dialog.io/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/reactivate

Example request:

curl --request POST
--url https://hub.360dialog.io/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/reactivate
--header 'Accept: application/json'
--header 'Content-Type: application/json'

Path parameters:

Name

Type

Description

partner_id*

string

The ID of the partner.

Example: examplePA

client_id*

string

The ID of the client.

Example: exampleCL

channel_id*

string

The ID of the channel.

Example: exampleCH

{
  "id": "exampleCH",
  "client_id": "exampleCL",
  "billing_started_at": null,
  "created_at": "2024-08-01T00:00:00Z",
  "current_limit": "TIER_1K",
  "is_oba": false,
  "current_quality_rating": "High",
  "settings": {
    "tier": "basic"
  },
  "availability_status": "error",
  "setup_info": {
    "phone_name": "Company",
    "phone_number": "49200200300"
  },
  "cancelled_at": "2024-09-01T00:00:00Z",
  "terminated_at": "2024-10-01T00:00:00Z",
  "status": "verified"
}

{
  "meta": {
    "360dialog_trace_id": "7234rgt4ubwfr347REQ",
    "success": false,
    "http_code": 400,
    "developer_message": "Revoke cancellation is not possible! 30 days passed from stack deletion and stack is hard deleted now. Please onboard the number again."
  }
}

Allow Clients to Add Phone Numbers

This endpoint is available only for Partners utilising the Partner-Paid model.

PATCH https://hub.360dialog.io/api/v2/partners/{partner_id}

The default value is ON. When set to OFF, the "Add Number" button will not be visible in the 360dialog Client Hub.

Example request

curl --request PATCH
--url https://hub.360dialog.io/api/v2/partners/partner_id
--header 'Accept: application/json'
--header 'Authorization: '
--header 'Content-Type: application/json'
--data '{ 
        "webhook_url": "string",
        "partner_redirect_url": "string",
        "allow_client_to_add_phone_no": true
    }'

Path Parameters

Name

Type

Description

partner-id*

String

The ID of the partner.

Example: examplePA

Request Body

Name

Type

Description

allow_client_to_add_phone_no*

boleean

default: true

partner_redirect_url*

string

webhook_url*

string

{
  "webhook_url": "string",
  "partner_redirect_url": "string",
  "brand_name": null,
  "id": "string",
  "logo_url": null,
  "onboarding_deeplink_add_params": true,
  "payment_plan": {},
  "payment_required": true
}

Enable Local Storage

POST /https://hub.360dialog.io/api/v2 /partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/enable_local_storage

Enable local storage for a channel.

Request Example:

curl --request POST
--url https://hub.360dialog.io/api/v2/partners/partner_id/clients/client_id/channels/channel_id/control/enable_local_storage
--header 'Accept: application/json'
--header 'Authorization: Bearer 123'
--header 'Content-Type: application/json'
--data '{ "data_localization_region": "DE" }'

Path Parameters

Name

Type

Description

channel_id*

String

The ID of the channel. Example: exampleCH

client_id*

String

The ID of the client.

Example: exampleCL

partner_id*

String

The ID of the partner.

Example: examplePA

Request Body

Name

Type

Description

data_localization_region*

string

Australia, value: AU

Indonesia, value: ID

South Africa, value: ZA

India, value: IN

Canada, value: CA

Japan, value: JP

Singapore, value: SG

South Korea, value: KR

Germany, value: DE

Switzerland, value: CH

United Kingdom, value: GB

Brazil, value: BRBahrain, value: BH

{
  "meta": {
    "success": true,
    "http_code": 200,
    "developer_message": "Local storage setting successfully adjusted."
  }
}

Disable Local Storage

POST https://hub.360dialog.io/api/v2 /partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/disable_local_storage

Enable local storage for a channel.

Request Example:

curl --request POST
--url https://hub.360dialog.io/api/v2/partners/partner_id/clients/client_id/channels/channel_id/control/disable_local_storage
--header 'Accept: application/json'
--header 'Authorization: Bearer 123'
--header 'Content-Type: application/json'

Path Parameters

Name

Type

Description

channel_id*

String

The ID of the channel. Example: exampleCH

client_id*

String

The ID of the client.

Example: exampleCL

partner_id*

String

The ID of the partner.

Example: examplePA

{
  "meta": {
    "success": true,
    "http_code": 200,
    "developer_message": "Local storage setting successfully adjusted."
  }
}

Set Default Data Localization Region

PATCH https://hub.360dialog.io/api/v2 /partners/{partner_id}/settings/default_data_localization_region

Set default data localization region. Once this region is configured, it will be used as default for all new Cloud API numbers registered with the specified Partner Account.

Request Example

curl --request PATCH
--url https://hub.360dialog.io/api/v2/partners/partner_id/settings/default_data_localization_region
--header 'Accept: application/json'
--header 'Authorization: Bearer 123'
--header 'Content-Type: application/json'
--data '{ "default_data_localization_region": "string" }'

Path Parameters

Name

Type

Description

partner_id*

string

The ID of the partner.

Example: examplePA

Request Body

Name

Type

Description

default_data_localization_region*

String

Allowed values: AU, ID, IN, JP, SG, KR, DE, CH, GB, BR, BH, ZA, CA

See Architecture and Security.

{
  "meta": {
    "developer_message": "Default data localization region updated successfully.",
    "http_code": 200,
    "success": true
  },
  "data": {
    "default_data_localization_region": "DE"
  }
}

{
  "meta": {
    "details": {
      "json": {
        "default_data_localization_region": [
          "Must be one of: AU, ID, IN, JP, SG, KR, DE, CH, GB, BR, BH, ZA, CA."
        ]
      }
    },
    "developer_message": "Wrong payload",
    "http_code": 400,
    "success": false
  }
}

PreviousOverview NextUsing the Partner Hub to manage Clients and Channels

Last updated 8 days ago

Was this helpful?

hashtagGet Clients

hashtagPath Parameters

hashtagQuery Parameters

hashtagHeaders

hashtagGet Client Balance

hashtagPath Parameters

hashtagQuery Parameters

hashtagGet Channels

hashtagPath Parameters

hashtagQuery Parameters

hashtagGet Managed Numbers

hashtagPath Parameters

hashtagSet Partner Webhook URL

hashtagPath Parameters

hashtagRequest Body

hashtagGet Partner Webhook URL

hashtagPath Parameters

hashtagSet Redirect URL

hashtagPath Parameters

hashtagRequest Body

hashtagGet Partner Info

hashtagPath Parameters

hashtagCreate API Key

hashtagPath Parameters

hashtagUpdate Max Channels

hashtagPath Parameters

hashtagRequest Body

hashtagUpdate Display Name

hashtagPath Parameters

hashtagCancel Subscription

hashtagPath Parameters

hashtagReactivate channel

hashtagAllow Clients to Add Phone Numbers

hashtagPath Parameters

hashtagRequest Body

hashtagEnable Local Storage

hashtagPath Parameters

hashtagRequest Body

hashtagDisable Local Storage

hashtagPath Parameters

hashtagSet Default Data Localization Region

hashtagPath Parameters

hashtagRequest Body

Get Clients

Path Parameters

Query Parameters

Headers

Get Client Balance

Path Parameters

Query Parameters

Get Channels

Path Parameters

Query Parameters

Get Managed Numbers

Path Parameters

Set Partner Webhook URL

Path Parameters

Request Body

Get Partner Webhook URL

Path Parameters

Set Redirect URL

Path Parameters

Request Body

Get Partner Info

Path Parameters

Create API Key

Path Parameters

Update Max Channels

Path Parameters

Request Body

Update Display Name

Path Parameters

Cancel Subscription

Path Parameters

Reactivate channel

Allow Clients to Add Phone Numbers

Path Parameters

Request Body

Enable Local Storage

Path Parameters

Request Body

Disable Local Storage

Path Parameters

Set Default Data Localization Region

Path Parameters

Request Body