Settings

Endpoints for managing various settings and configurations

Set account sharing settings

patch

This endpoint allows partners to set their account sharing settings.

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_idstring · nullableOptional

The solution id that is created and approved on Meta

Example: 1343564534452435

business_manager_idstring · nullableOptional

The business manager id that is connected to the solution agreement

Example: 24862834653473623

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

403

Forbidden

application/json

404

Not found

application/json

patch

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

HTTPcURLJavaScriptPython

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

{
  "solution_id": "1343564534452435",
  "business_manager_id": "24862834653473623"
}

{
  "meta": {
    "developer_message": "Request processed successfully",
    "http_code": 200,
    "success": true,
    "360dialog_trace_id": "abcnop3456REQ"
  },
  "status_code": 200,
  "data": {
    "solution_id": "1343564534452435",
    "business_manager_id": "24862834653473623",
    "solution_status": "ACTIVE"
  }
}

Set partner change request settings

patch

This endpoint allows partners to set their partner change request settings (like auto approval).

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

auto_approvebooleanRequired

When true, all the partner change requests from other clients to your partner hub will be automatically approved.

Example: true

Responses

200

Successful response

application/json

auto_approvebooleanRequired

When true, all the partner change requests from other clients to your partner hub will be automatically approved.

Example: true

400

Wrong payload

application/json

404

Not found

application/json

patch

/api/v2/partners/{partner_id}/settings/partner_change_request

HTTPcURLJavaScriptPython

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

{
  "auto_approve": true
}

{
  "auto_approve": true
}

Toggle routing of marketing templates via Marketing Messages API.

patch

This endpoint allows updating the use_marketing_messages_api flag.

If the use_marketing_messages_api flag is set to True, the marketing templates will be routed through the Marketing Messages API for all channels. If set to False, the marketing templates will not be routed through the Marketing Messages API for all channels.

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

use_marketing_messages_apibooleanRequired

When true, marketing template requests are routed through the Marketing Messages API.

Example: true

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

patch

/api/v2/partners/{partner_id}/settings/marketing_templates_routing

HTTPcURLJavaScriptPython

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

{
  "use_marketing_messages_api": true
}

{
  "meta": {
    "developer_message": "Request processed successfully",
    "http_code": 200,
    "success": true,
    "360dialog_trace_id": "abcnop3456REQ"
  },
  "status_code": 200
}

Set default data localization region settings

patch

This endpoint allows partners to set default data localization region for future numbers. The default data localization region is the region of the local storage in the Meta infrastructure. Meta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/overview/local-storage/

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

default_data_localization_regionstring · enumRequired

The default region for all new channels to store messaging data on Meta infrastructure

Example: DEPossible values:

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

patch

/api/v2/partners/{partner_id}/settings/default_data_localization_region

HTTPcURLJavaScriptPython

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

{
  "default_data_localization_region": "DE"
}

{
  "meta": {
    "developer_message": "Request processed successfully",
    "http_code": 200,
    "success": true,
    "360dialog_trace_id": "abcnop3456REQ"
  },
  "status_code": 200,
  "data": {
    "default_data_localization_region": "DE"
  }
}