Channel Management

Endpoints for managing channels (phone numbers) and their settings

Retrieve list of channels

get

This endpoint allows partners to retrieve the list of owned 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

Query parameters

sortstring · enumOptional

Sort results by channel, client, project, waba_accounte, integration fields

Example: statusPossible 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 channel, client, project, integration, waba_account fields

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

totalintegerOptional

Total number of results

Example: 1

countintegerOptional

Number of results returned

Example: 1

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/channels

HTTPcURLJavaScriptPython

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

{
  "limit": 10,
  "offset": 0,
  "sort": [
    "created_at",
    "-modified_at"
  ],
  "filters": {
    "setup_info.phone_number": {
      "like": "555"
    }
  },
  "total": 1,
  "count": 1,
  "partner_channels": [
    {
      "status": "ready",
      "cancelled_at": "2024-08-01T00:00:00Z",
      "client_id": "exampleCL",
      "created_at": "2024-01-01T00:00:00Z",
      "current_limit": "TIER_1K",
      "current_quality_rating": "Medium",
      "is_oba": true,
      "availability_status": "ready",
      "settings": {
        "tier": "premium",
        "data_localization_region": "US"
      },
      "setup_info": {
        "phone_name": "Company Name",
        "phone_number": "[phone]"
      },
      "terminated_at": "2024-09-01T00:00:00Z",
      "is_on_biz_app": true,
      "client": {
        "id": "exampleCL",
        "name": "Company",
        "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"
        },
        "partner_payload": "This client account is created for a specific purpose"
      },
      "waba_account": {
        "status": "approved",
        "id": "exampleWA",
        "on_behalf_of_business_info": {
          "id": "2394629384624273",
          "name": "Company",
          "status": "approved",
          "type": "EXISTING_CLIENT"
        },
        "fb_account_status": "verified",
        "namespace": "09e8c464_3456_4d6d_ab89_ekfjb43r8gh",
        "external_id": "78364873526355",
        "fb_business_id": "23443543453256",
        "settings": {
          "marketing_messages_lite_api_status": "ELIGIBLE"
        }
      },
      "integration": {
        "state": "running",
        "enabled": true,
        "app_id": "13345",
        "hosting_platform_type": "meta_cloud_api"
      }
    }
  ]
}

Generate API Key for a Specified Channel

post

This endpoint allows partners to create an API key for a specified channel. The created API key can be used to authenticate and access specific services (like messaging or template management) linked to the channel. Rate limits: This endpoint is subject to rate limits. A maximum of 1 request in 30 seconds per channel is allowed. Requests exceeding these limits will receive a 429 Too Many Requests response.

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

partner_idstringRequired

The ID of the partner.

Example: examplePA

Responses

200

Successful response

application/json

400

Wrong payload

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Client error

application/json

post

/api/v2/partners/{partner_id}/channels/{channel_id}/api_keys

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/channels/{channel_id}/api_keys HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "1",
  "address": "https://waba-v2.360dialog.io",
  "api_key": "671c0b296e15847015efc87298114ceac4572d4d",
  "app_id": "12345"
}

Get List of Blocked Users for a channel

get

This endpoint retrieves the list of users blocked by partner Meta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/block-users

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

partner_idstringRequired

The ID of the partner.

Example: examplePA

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/channels/{channel_id}/block_users

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "developer_message": "Request processed successfully",
    "http_code": 200,
    "success": true,
    "360dialog_trace_id": "abcnop3456REQ"
  },
  "status_code": 200,
  "data": {
    "block_users": [
      {
        "input": "49100100200",
        "wa_id": "49100100200"
      }
    ]
  }
}

Block users for a channel

post

This endpoint allows blocking a list of users by phone number or whatsapp id. Meta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/block-users

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/channels/{channel_id}/block_users

HTTPcURLJavaScriptPython

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

{
  "block_users": [
    {
      "user": "49100100200"
    }
  ]
}

{
  "meta": {
    "developer_message": "Request processed successfully",
    "http_code": 200,
    "success": true,
    "360dialog_trace_id": "abcnop3456REQ"
  },
  "status_code": 200,
  "data": {
    "messaging_product": "whatsapp",
    "block_users": {
      "added_users": [
        {
          "input": "49100100200",
          "wa_id": "49100100200"
        }
      ],
      "removed_users": [
        {
          "input": "49100100200",
          "wa_id": "49100100200"
        }
      ],
      "failed_users": [
        {
          "input": "49100100200",
          "wa_id": "49100100200",
          "errors": [
            {
              "message": "Re-engagement check failed",
              "code": 139100,
              "error_data": {
                "details": "Failed to block due to re-engagement check failed"
              }
            }
          ]
        }
      ]
    },
    "errors": {
      "message": "(#139100) Failed to block/unblock users",
      "type": "OAuthException",
      "code": 139100,
      "error_data": {
        "details": "Failed to block some users, see the block_users response list for details"
      },
      "fbtrace_id": "BLBz/WZt8dN"
    }
  }
}

Unblock users for a channel

delete

This endpoint allows unblocking a list of users by phone number or whatsapp id. Meta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/block-users

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

delete

/api/v2/partners/{partner_id}/channels/{channel_id}/block_users

HTTPcURLJavaScriptPython

DELETE /api/v2/partners/{partner_id}/channels/{channel_id}/block_users HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "block_users": [
    {
      "user": "49100100200"
    }
  ]
}

{
  "meta": {
    "developer_message": "Request processed successfully",
    "http_code": 200,
    "success": true,
    "360dialog_trace_id": "abcnop3456REQ"
  },
  "status_code": 200,
  "data": {
    "messaging_product": "whatsapp",
    "block_users": {
      "added_users": [
        {
          "input": "49100100200",
          "wa_id": "49100100200"
        }
      ],
      "removed_users": [
        {
          "input": "49100100200",
          "wa_id": "49100100200"
        }
      ],
      "failed_users": [
        {
          "input": "49100100200",
          "wa_id": "49100100200",
          "errors": [
            {
              "message": "Re-engagement check failed",
              "code": 139100,
              "error_data": {
                "details": "Failed to block due to re-engagement check failed"
              }
            }
          ]
        }
      ]
    },
    "errors": {
      "message": "(#139100) Failed to block/unblock users",
      "type": "OAuthException",
      "code": 139100,
      "error_data": {
        "details": "Failed to block some users, see the block_users response list for details"
      },
      "fbtrace_id": "BLBz/WZt8dN"
    }
  }
}

Update display name.

put

Update display name of a partner channel.

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

Body

application/json

namestringRequired

The new display name for the channel.

Example: My New Display Name

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

put

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

HTTPcURLJavaScriptPython

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

{
  "name": "My New Display Name"
}

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

Reactivate a previously cancelled channel.

post

This endpoint works by revoking a previously requested cancellation for a specific channel. Channel should be paid by partner and not completely deleted.

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

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

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/reactivate

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/reactivate 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"
}

Retrieve whatsapp commerce settings for a specific channel

get

This endpoint allows partners to get whatsapp commerce settings for a specific number. It acts as a proxy for Meta's API to retrieve commerce settings (like catalog visibility and cart enablement). Meta documentation: https://developers.facebook.com/documentation/business-messaging/whatsapp/catalogs/sell-products-and-services/set-commerce-settings/#get-commerce-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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

Responses

200

Successful response

application/json

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/whatsapp_commerce_settings

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "43857923468734",
      "is_cart_enabled": true,
      "is_catalog_visible": true
    }
  ]
}

Update whatsapp commerce settings for a specific channel

post

This endpoint allows partners to update whatsapp commerce settings for a specific number.

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

Body

application/json

is_cart_enabledbooleanRequired

When true, cart-related buttons appear in the conversation, catalog, and product details views

Example: true

is_catalog_visiblebooleanRequired

When true, the catalog storefront icon and catalog-related buttons appear in conversation and business profile views

Example: true

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/whatsapp_commerce_settings

HTTPcURLJavaScriptPython

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

{
  "is_cart_enabled": true,
  "is_catalog_visible": true
}

{
  "meta": {
    "developer_message": "Whatsapp commerce settings successfully updated",
    "http_code": 200,
    "success": true
  },
  "status_code": 200
}

Request cancellation for a specific channel

post

The channel will be marked for cancellation and will be deactivated at the end of the month.

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

channel_idstringRequired

The ID of the channel.

Example: exampleCH

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

post

/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/cancellation_request

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/cancellation_request 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"
}

Enable local storage for a specific channel

post

This endpoint allows partners to enable local storage for a channel. Cloud API Local Storage gives you the option to control where your message data is stored at rest. 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

client_idstringRequired

The ID of the client.

Example: exampleCL

partner_idstringRequired

The ID of the partner.

Example: examplePA

channel_idstringRequired

The ID of the channel.

Example: exampleCH

Body

application/json

data_localization_regionstring · enumRequired

The region for channel 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

502

Server error

application/json

post

/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/enable_local_storage

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/enable_local_storage HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "data_localization_region": "DE"
}

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

Disable local storage for a specific channel

post

This endpoint allows partners to disable local storage for a channel. Cloud API Local Storage gives you the option to control where your message data is stored at rest. 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

client_idstringRequired

The ID of the client.

Example: exampleCL

partner_idstringRequired

The ID of the partner.

Example: examplePA

channel_idstringRequired

The ID of the channel.

Example: exampleCH

Responses

200

Successful response

application/json

status_codeintegerRequiredExample: 200

400

Wrong payload

application/json

404

Not found

application/json

502

Server error

application/json

post

/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/disable_local_storage

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/disable_local_storage HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

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