> For the complete documentation index, see [llms.txt](https://docs.360dialog.com/partner/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.360dialog.com/partner/partner-api/api-reference/channel-management.md).

# Channel Management

Endpoints for managing channels (phone numbers) and their settings

## Retrieve list of channels

> This endpoint allows partners to retrieve the list of owned channels.

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"PartnerChannelsListFilterIn":{"type":"object","properties":{"q":{"type":"string"},"meta_status":{},"id":{},"type":{},"status":{},"client_id":{},"version":{},"is_migrated":{},"account_mode":{},"terminated_at":{"nullable":true},"current_limit":{"nullable":true},"current_quality_rating":{"nullable":true},"availability_status":{},"profile_info.about_text":{},"profile_info.business_vertical":{},"profile_info.business_description":{},"profile_info.contact_email":{},"setup_info.phone_number":{},"setup_info.phone_name":{},"setup_info.was_in_use":{},"setup_info.ivr":{},"setup_info.verification_method":{},"setup_info.default_language":{},"created_at":{},"modified_at":{},"external_id":{},"project.id":{},"project.name":{},"project.license_model":{},"project.inbox":{},"project.api_user_email":{},"project.status":{},"project.created_at":{},"project.modified_at":{},"client.id":{},"client.name":{},"client.organisation":{},"client.status":{},"client.partner_payload":{},"client.meta_info.business_vertical":{},"client.meta_info.timezone":{},"client.meta_info.about":{},"client.meta_info.business_description":{},"client.meta_info.use_case":{},"client.contact_info.webpage_url":{},"client.contact_info.phone":{},"client.contact_info.language":{},"client.contact_info.country":{},"client.contact_info.street_name":{},"client.contact_info.city":{},"client.contact_info.email":{},"client.contact_info.zip_code":{},"client.contact_user.phone":{},"client.contact_user.email":{},"client.contact_user.name":{},"client.created_at":{},"client.modified_at":{},"partner.id":{},"partner.name":{},"integration.id":{},"integration.app_id":{},"integration.type":{},"integration.stack_id":{},"integration.state":{},"integration.parameters.default_language":{},"integration.parameters.verification_method":{},"integration.parameters.app_name":{},"integration.parameters.organisation":{},"integration.parameters.api_user_email":{},"integration.hosting_platform_type":{},"integration.created_at":{},"integration.modified_at":{},"waba_account.id":{},"waba_account.name":{},"waba_account.namespace":{},"waba_account.status":{},"waba_account.external_id":{},"waba_account.fb_business_id":{},"waba_account.on_behalf_of_business_info.id":{},"waba_account.on_behalf_of_business_info.name":{},"waba_account.on_behalf_of_business_info.status":{},"waba_account.on_behalf_of_business_info.type":{},"waba_account.created_at":{},"waba_account.modified_at":{},"waba_account.settings.marketing_messages_lite_api_status":{},"channel_settings.settings.tier":{}},"additionalProperties":false},"PartnerChannelsPublicOut":{"type":"object","properties":{"limit":{"type":"integer","description":"Maximum number of results to return"},"offset":{"type":"integer","description":"Number of results to skip"},"sort":{"type":"array","description":"Sort results by channel, client, project, integration, waba_account fields","items":{"type":"string"}},"filters":{"type":"object","description":"Filter results by channel, channel settings, client, project, integration, waba_account, partner fields","additionalProperties":{}},"total":{"type":"integer","description":"Total number of results"},"count":{"type":"integer","description":"Number of results returned"},"partner_channels":{"type":"array","description":"List of channel objects","items":{"$ref":"#/components/schemas/PartnerChannelsPublicPayload"}}},"additionalProperties":false},"PartnerChannelsPublicPayload":{"type":"object","properties":{"status":{"type":"string","enum":["created","unverified","verified","ready","transferred","modified","imported","new_name_requested","certificate_declined","consents_signed","error","porting_ready","ready_for_migration","waiting_for_migration_code","migration_code_requested","migration_verified","unregistered","removed"],"description":"Current status of the channel. Possible values are:\n- **created**: The channel is created and process for onboarding is started.\n- **unverified**: The channel is submitted to Meta and waiting for them to verify the display name.\n- **verified**: The channel display name is verified by Meta.\n- **ready**: The channel onboarding is completed and can be used for sending and receiving messages.\n- **transferred**: The channel is transferred to another BSP and 360dialog does not have access to it.\n- **modified**: [deprecated] When a channel name is updated.\n- **imported**: [deprecated]\n- **new_name_requested**: A new display name is requested for the channel and waiting for Meta's approval.\n- **certificate_declined**: The channel display name is rejected by Meta.\n- **consents_signed**: [deprecated]\n- **error**: Channel setup is failed for any reason and channel can not be used for messaging.\n- **porting_ready**: [deprecated]\n- **ready_for_migration**: [deprecated] A new channel is created to migrate a phone number from another BSP to 360dialog.\n- **waiting_for_migration_code**: [deprecated] Channel migration is initiated and next step is requesting a migration code from Meta.\n- **migration_code_requested**: [deprecated] Channel migration code is requested from Meta.\n- **migration_verified**: [deprecated] Channel migration is verified.\n- **unregistered**: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.\n- **removed**: 360dialog does not have access to the number on Meta."},"id":{"type":"string","description":"Channel ID","deprecated":true},"account_mode":{"type":"string","description":"[Deprecated] can be live or sandbox","deprecated":true},"billing_started_at":{"type":"string","description":"[Deprecated]","deprecated":true},"cancelled_at":{"type":"string","description":"Channel cancellation datetime","nullable":true},"client_id":{"type":"string","description":"Client ID that is the owner of the channel"},"created_at":{"type":"string","description":"Channel creation datetime"},"current_limit":{"type":"string","description":"Meta's number current limit, can be NA or from TIER_50 to TIER_UNLIMITED"},"current_quality_rating":{"type":"string","description":"Meta's number current quality rating, can be NA, Low, Medium or High"},"is_migrated":{"type":"boolean","description":"[Internal Field]","deprecated":true},"is_oba":{"type":"boolean","description":"Indicates if business phone number is an Meta's [Official Business Account](https://developers.facebook.com/docs/whatsapp/overview/business-accounts/#official-business-account)."},"has_inbox":{"type":"boolean","description":"[Internal Field]","deprecated":true},"hub_status":{"type":"string","description":"**[Deprecated]** Current hub status of the channel. Use `availability_status` as the source of truth. Possible values are:\n- **live**: Number is live and connected and messaging is available.\n- **sandbox**: [deprecated] Number is available in sandbox environment.\n- **done**: [deprecated] Same as live.\n- **pending**: [deprecated] [on-prem] An on-prem stack is being setup.\n- **draft**: Stack is being setup for the number.\n- **pending_deletion**: Number will be terminated soon.\n- **unregistered**: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.\n- **unknown**: Unknown status. Needs to be checked by support.","deprecated":true},"availability_status":{"type":"string","enum":["setting_up","ready","error","cancelled","inactive"],"description":"Current availability status of the channel. This is the unified source of truth for channel availability. Possible values are:\n- **setting_up**: Channel is being set up\n- **ready**: Channel is ready and available for messaging\n- **error**: Channel has an error and is not available for messaging\n- **cancelled**: Channel is cancelled (cancelled_at is set, not yet terminated)\n- **inactive**: Channel is inactive (terminated_at is in the past)","nullable":true},"settings":{"description":"Channel settings","allOf":[{"$ref":"#/components/schemas/_Settings"}]},"setup_info":{"description":"Channel setup information","allOf":[{"$ref":"#/components/schemas/ChannelPublicSetupInfo"}]},"terminated_at":{"type":"string","description":"Channel termination datetime","nullable":true},"version":{"type":"integer","description":"[Deprecated]","deprecated":true},"is_on_biz_app":{"type":"boolean","description":"Indicates that the WhatsApp business phone number is used with the WhatsApp Business app."},"client":{"description":"Client information that is the owner of the channel","allOf":[{"$ref":"#/components/schemas/ClientPublicOut"}]},"waba_account":{"description":"Waba account information that number belongs to","allOf":[{"$ref":"#/components/schemas/WabaAccountPublicOut"}]},"integration":{"description":"Integration information that number is connected to","allOf":[{"$ref":"#/components/schemas/IntegrationPublicOut"}]}},"additionalProperties":false},"_Settings":{"type":"object","properties":{"tier":{"type":"string","description":"Billing tier","nullable":true},"data_localization_region":{"type":"string","description":"The region where your message data is stored on Meta infrastructure https://www.facebook.com/legal/Meta-Hosting-Terms-Cloud-API","nullable":true},"throughput":{"description":"Current throughput settings","anyOf":[{"$ref":"#/components/schemas/Throughput"},{"type":"object","nullable":true}]}},"additionalProperties":false},"Throughput":{"type":"object","properties":{"level":{"type":"string","description":"Current throughput level","nullable":true}},"additionalProperties":false},"ChannelPublicSetupInfo":{"type":"object","properties":{"phone_name":{"type":"string","description":"Meta's phone name","nullable":true},"phone_number":{"type":"string","description":"Phone number","nullable":true}},"additionalProperties":false},"ClientPublicOut":{"type":"object","properties":{"id":{"type":"string","description":"Client ID"},"name":{"type":"string","description":"Client name"},"contact_info":{"description":"Client contact information","allOf":[{"$ref":"#/components/schemas/ContactInfo"}]},"partner_payload":{"type":"string","description":"Optional field that partner can use to configure something on their logic or distinguish clients based on different values"}},"additionalProperties":false},"ContactInfo":{"type":"object","properties":{"email":{"type":"string","format":"email","nullable":true},"webpage_url":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"country":{"type":"string","description":"Country code","nullable":true},"street_name":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true}},"additionalProperties":false},"WabaAccountPublicOut":{"type":"object","properties":{"status":{"type":"string","enum":["created","consents_pending","unverified","pending","approved","imported","sandbox","verification_failed","account_violation","account_restriction","account_banned","account_offboarded","account_reconnected","modified","error","bsp_removed"],"description":"Current status of the waba account. Possible values are:\n- **created**: Initial status of a new waba account.\n- **consents_pending**: Waiting for client to sign the agreements they received by email.\n- **unverified**: Waiting for Meta to approve the waba account.\n- **pending**: [deprecated]\n- **approved**: Waba account is approved by Meta.\n- **imported**: [deprecated]\n- **sandbox**: [deprecated]\n- **verification_failed**: [deprecated]\n- **account_violation**: Waba account violated Meta rules.\n- **account_restriction**: Waba account is restricted by Meta because of violating rules.\n- **account_banned**: Waba account is disabled/banned by Meta.\n- **modified**: [deprecated] When waba account name is updated.\n- **error**: [deprecated]\n- **bsp_removed**: 360dialog does not have access to waba account on Meta."},"id":{"type":"string","description":"Waba account ID"},"on_behalf_of_business_info":{"description":"Meta's OBO Business information","anyOf":[{"$ref":"#/components/schemas/WabaOnBehalfOfBusinessInfo"},{"type":"object","nullable":true}]},"fb_account_status":{"type":"string","description":"Meta's business account status"},"namespace":{"type":"string","description":"Meta's WABA namespace on Meta"},"external_id":{"type":"string","description":"Meta's Whatsapp Business Account ID"},"fb_business_id":{"type":"string","description":"Meta's business account ID of WABA's owner"},"settings":{"description":"Waba account settings","anyOf":[{"$ref":"#/components/schemas/WabaAccountPublicSettings"},{"type":"object","nullable":true}]}},"additionalProperties":false},"WabaOnBehalfOfBusinessInfo":{"type":"object","properties":{"id":{"type":"string","description":"OBO Business ID"},"name":{"type":"string","description":"OBO Business name"},"status":{"type":"string","description":"OBO Business status on Meta"},"type":{"type":"string","description":"OBO Business type"}},"additionalProperties":false},"WabaAccountPublicSettings":{"type":"object","properties":{"marketing_messages_lite_api_status":{"type":"string","description":"MM Lite eligibility status of a WABA","nullable":true}},"additionalProperties":false},"IntegrationPublicOut":{"type":"object","properties":{"state":{"type":"string","description":"Current state of the integration"},"enabled":{"type":"boolean","description":"True means that outbound messaging is enabled"},"app_id":{"type":"string","description":"Integration application ID"},"hosting_platform_type":{"type":"string","description":"Integration hosting platform type. If not `meta_cloud_api`, should be migrated to Meta's Cloud API"}},"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/channels":{"get":{"parameters":[{"in":"query","name":"filters","description":"Filter results by channel, channel settings, client, project, waba_account, integration, partner fields","schema":{"allOf":[{"$ref":"#/components/schemas/PartnerChannelsListFilterIn"}]},"required":false},{"in":"query","name":"sort","description":"Sort results by channel, client, project, waba_accounte, integration fields","schema":{"type":"string","enum":["id","type","status","current_limit","current_quality_rating","profile_info.about_text","profile_info.business_vertical","profile_info.business_description","profile_info.contact_email","setup_info.phone_number","setup_info.phone_name","setup_info.was_in_use","setup_info.ivr","setup_info.verification_method","setup_info.default_language","created_at","modified_at","project.id","project.name","project.license_model","project.inbox","project.api_user_email","project.status","project.created_at","project.modified_at","client.id","client.name","client.organisation","client.status","client.partner_payload","client.meta_info.business_vertical","client.meta_info.timezone","client.meta_info.about","client.meta_info.business_description","client.meta_info.use_case","client.contact_info.webpage_url","client.contact_info.phone","client.contact_info.language","client.contact_info.country","client.contact_info.street_name","client.contact_info.city","client.contact_info.email","client.contact_info.zip_code","client.contact_user.phone","client.contact_user.email","client.contact_user.name","client.created_at","client.modified_at","integration.id","integration.app_id","integration.type","integration.stack_id","integration.state","integration.parameters.default_language","integration.parameters.verification_method","integration.parameters.app_name","integration.parameters.organisation","integration.parameters.api_user_email","integration.created_at","integration.modified_atwaba_account.id","waba_account.name","waba_account.namespace","waba_account.status","waba_account.external_id","waba_account.fb_business_id","waba_account.on_behalf_of_business_info.id","waba_account.on_behalf_of_business_info.name","waba_account.on_behalf_of_business_info.status","waba_account.on_behalf_of_business_info.type","waba_account.created_at","waba_account.modified_at"]},"required":false},{"in":"query","name":"offset","description":"Number of results to skip","schema":{"type":"integer"},"required":false},{"in":"query","name":"limit","description":"Maximum number of results to return","schema":{"type":"integer"},"required":false},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerChannelsPublicOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Retrieve list of channels","description":"This endpoint allows partners to retrieve the list of owned channels.","operationId":"get_channel_management_docs_api_get_public_channels"}}}}
```

## Generate API Key for a Specified Channel

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"ApiKeyOut":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the API key."},"address":{"type":"string","description":"The base URL to call a messaging and others API with this API key"},"api_key":{"type":"string","description":"The generated API key."},"app_id":{"type":"string","description":"The application ID associated with the API key."}},"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/channels/{channel_id}/api_keys":{"post":{"parameters":[{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyOut"}}},"description":"Successful response","headers":{"RateLimit-Limit":{"schema":{"type":"integer"},"description":"The maximum quota units allowed in the current window (from the most critical policy).","required":true},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":"The number of remaining quota units (from the most critical policy).","required":true},"RateLimit-Reset":{"schema":{"type":"integer"},"description":"The time, in seconds, until the critical rate limit resets.","required":true},"RateLimit-Policy":{"schema":{"type":"string"},"description":"A Structured Field string listing all concurrent policies enforced by the server.","required":true}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Client error"}},"tags":["Channel Management"],"summary":"Generate API Key for a Specified Channel","description":"This endpoint allows partners to create an API key for a specified channel.\nThe created API key can be used to authenticate and access specific services\n(like messaging or template management) linked to the channel.\n**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.","operationId":"post_channel_management_docs_api_create_by_channel_id"}}}}
```

## Get List of Blocked Users for a channel

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

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"GetBlockUsersOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"},"data":{"description":"Blocked users","allOf":[{"$ref":"#/components/schemas/GetBlockUsersData"}]}},"required":["data","meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"GetBlockUsersData":{"type":"object","properties":{"block_users":{"type":"array","description":"List of blocked users","items":{"$ref":"#/components/schemas/GetBlockUsersDataBlockedUsers"}}},"required":["block_users"],"additionalProperties":false},"GetBlockUsersDataBlockedUsers":{"type":"object","properties":{"input":{"type":"string","description":"Phone number or Whatsapp id of the user"},"wa_id":{"type":"string","description":"Whatsapp id of the user"}},"required":["input"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/channels/{channel_id}/block_users":{"get":{"parameters":[{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockUsersOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Get List of Blocked Users for a channel","description":"This endpoint retrieves the list of users blocked by partner\nMeta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/block-users","operationId":"get_channel_management_docs_api_get_block_users"}}}}
```

## Block users for a channel

> 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>

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"PostBlockUsersOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"},"data":{"description":"Blocked/Unblocked users","allOf":[{"$ref":"#/components/schemas/PostBlockUsersData"}]}},"required":["data","meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"PostBlockUsersData":{"type":"object","properties":{"messaging_product":{"type":"string","description":"Messaging product value on Meta (currently only whatsapp)"},"block_users":{"description":"Blocked/Unblocked users data","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataBlockUsers"}]},"errors":{"description":"Errors occur during the operation","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataErrors"}]}},"required":["block_users","messaging_product"],"additionalProperties":false},"PostBlockUsersDataBlockUsers":{"type":"object","properties":{"added_users":{"type":"array","description":"List of users successfully blocked","items":{"$ref":"#/components/schemas/GetBlockUsersDataBlockedUsers"}},"removed_users":{"type":"array","description":"List of users successfully unblocked","items":{"$ref":"#/components/schemas/GetBlockUsersDataBlockedUsers"}},"failed_users":{"type":"array","description":"List of users that block/unblock operation failed for them","items":{"$ref":"#/components/schemas/PostBlockUsersDataFailedUsers"}}},"additionalProperties":false},"GetBlockUsersDataBlockedUsers":{"type":"object","properties":{"input":{"type":"string","description":"Phone number or Whatsapp id of the user"},"wa_id":{"type":"string","description":"Whatsapp id of the user"}},"required":["input"],"additionalProperties":false},"PostBlockUsersDataFailedUsers":{"type":"object","properties":{"input":{"type":"string","description":"Phone number or Whatsapp id of the user"},"wa_id":{"type":"string","description":"Whatsapp id of the user"},"errors":{"type":"array","description":"List of errors that occur during the block/unblock operation","items":{"$ref":"#/components/schemas/PostBlockUsersDataBlockedFailedUsersErrors"}}},"required":["errors","input"],"additionalProperties":false},"PostBlockUsersDataBlockedFailedUsersErrors":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"},"error_data":{"description":"Error data","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataErrorData"}]}},"required":["code","error_data","message"],"additionalProperties":false},"PostBlockUsersDataErrorData":{"type":"object","properties":{"details":{"type":"string","description":"Error details"}},"required":["details"],"additionalProperties":false},"PostBlockUsersDataErrors":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"type":{"type":"string","description":"Error type"},"code":{"type":"integer","description":"Error code"},"error_data":{"description":"Error data","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataErrorData"}]},"fbtrace_id":{"type":"string","description":"FB trace id on Meta"}},"required":["code","error_data","message","type"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"BlockUsersIn":{"type":"object","properties":{"block_users":{"type":"array","minItems":1,"description":"List of users to block/unblock","items":{"$ref":"#/components/schemas/BlockUserIn"}}},"required":["block_users"],"additionalProperties":false},"BlockUserIn":{"type":"object","properties":{"user":{"type":"string","minLength":1,"description":"Phone number or Whatsapp id of the user"}},"required":["user"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/channels/{channel_id}/block_users":{"post":{"parameters":[{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBlockUsersOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Block users for a channel","description":"This endpoint allows blocking a list of users by phone number or whatsapp id.\nMeta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/block-users","operationId":"post_channel_management_docs_api_block_users","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersIn"}}}}}}}}
```

## Unblock users for a channel

> 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>

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"PostBlockUsersOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"},"data":{"description":"Blocked/Unblocked users","allOf":[{"$ref":"#/components/schemas/PostBlockUsersData"}]}},"required":["data","meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"PostBlockUsersData":{"type":"object","properties":{"messaging_product":{"type":"string","description":"Messaging product value on Meta (currently only whatsapp)"},"block_users":{"description":"Blocked/Unblocked users data","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataBlockUsers"}]},"errors":{"description":"Errors occur during the operation","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataErrors"}]}},"required":["block_users","messaging_product"],"additionalProperties":false},"PostBlockUsersDataBlockUsers":{"type":"object","properties":{"added_users":{"type":"array","description":"List of users successfully blocked","items":{"$ref":"#/components/schemas/GetBlockUsersDataBlockedUsers"}},"removed_users":{"type":"array","description":"List of users successfully unblocked","items":{"$ref":"#/components/schemas/GetBlockUsersDataBlockedUsers"}},"failed_users":{"type":"array","description":"List of users that block/unblock operation failed for them","items":{"$ref":"#/components/schemas/PostBlockUsersDataFailedUsers"}}},"additionalProperties":false},"GetBlockUsersDataBlockedUsers":{"type":"object","properties":{"input":{"type":"string","description":"Phone number or Whatsapp id of the user"},"wa_id":{"type":"string","description":"Whatsapp id of the user"}},"required":["input"],"additionalProperties":false},"PostBlockUsersDataFailedUsers":{"type":"object","properties":{"input":{"type":"string","description":"Phone number or Whatsapp id of the user"},"wa_id":{"type":"string","description":"Whatsapp id of the user"},"errors":{"type":"array","description":"List of errors that occur during the block/unblock operation","items":{"$ref":"#/components/schemas/PostBlockUsersDataBlockedFailedUsersErrors"}}},"required":["errors","input"],"additionalProperties":false},"PostBlockUsersDataBlockedFailedUsersErrors":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"},"error_data":{"description":"Error data","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataErrorData"}]}},"required":["code","error_data","message"],"additionalProperties":false},"PostBlockUsersDataErrorData":{"type":"object","properties":{"details":{"type":"string","description":"Error details"}},"required":["details"],"additionalProperties":false},"PostBlockUsersDataErrors":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"type":{"type":"string","description":"Error type"},"code":{"type":"integer","description":"Error code"},"error_data":{"description":"Error data","allOf":[{"$ref":"#/components/schemas/PostBlockUsersDataErrorData"}]},"fbtrace_id":{"type":"string","description":"FB trace id on Meta"}},"required":["code","error_data","message","type"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"BlockUsersIn":{"type":"object","properties":{"block_users":{"type":"array","minItems":1,"description":"List of users to block/unblock","items":{"$ref":"#/components/schemas/BlockUserIn"}}},"required":["block_users"],"additionalProperties":false},"BlockUserIn":{"type":"object","properties":{"user":{"type":"string","minLength":1,"description":"Phone number or Whatsapp id of the user"}},"required":["user"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/channels/{channel_id}/block_users":{"delete":{"parameters":[{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBlockUsersOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Unblock users for a channel","description":"This endpoint allows unblocking a list of users by phone number or whatsapp id.\nMeta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/block-users","operationId":"delete_channel_management_docs_api_unblock_users","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersIn"}}}}}}}}
```

## Update display name.

> Update display name of a partner channel.

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"DefaultHttpOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"}},"required":["meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"ChannelUpdateApiIn":{"type":"object","properties":{"name":{"type":"string","description":"The new display name for the channel."}},"required":["name"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}":{"put":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Update display name.","description":"Update display name of a partner channel.","operationId":"put_channel_management_docs_api_put_channel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelUpdateApiIn"}}}}}}}}
```

## Reactivate a previously cancelled channel.

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

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"SingleChannelPublicPayloadOut":{"type":"object","properties":{"status":{"type":"string","enum":["created","unverified","verified","ready","transferred","modified","imported","new_name_requested","certificate_declined","consents_signed","error","porting_ready","ready_for_migration","waiting_for_migration_code","migration_code_requested","migration_verified","unregistered","removed"],"description":"Current status of the channel. Possible values are:\n- **created**: The channel is created and process for onboarding is started.\n- **unverified**: The channel is submitted to Meta and waiting for them to verify the display name.\n- **verified**: The channel display name is verified by Meta.\n- **ready**: The channel onboarding is completed and can be used for sending and receiving messages.\n- **transferred**: The channel is transferred to another BSP and 360dialog does not have access to it.\n- **modified**: [deprecated] When a channel name is updated.\n- **imported**: [deprecated]\n- **new_name_requested**: A new display name is requested for the channel and waiting for Meta's approval.\n- **certificate_declined**: The channel display name is rejected by Meta.\n- **consents_signed**: [deprecated]\n- **error**: Channel setup is failed for any reason and channel can not be used for messaging.\n- **porting_ready**: [deprecated]\n- **ready_for_migration**: [deprecated] A new channel is created to migrate a phone number from another BSP to 360dialog.\n- **waiting_for_migration_code**: [deprecated] Channel migration is initiated and next step is requesting a migration code from Meta.\n- **migration_code_requested**: [deprecated] Channel migration code is requested from Meta.\n- **migration_verified**: [deprecated] Channel migration is verified.\n- **unregistered**: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.\n- **removed**: 360dialog does not have access to the number on Meta."},"id":{"type":"string","description":"Channel ID"},"cancelled_at":{"type":"string","description":"Channel cancellation datetime","nullable":true},"client_id":{"type":"string","description":"Client ID that is the owner of the channel"},"created_at":{"type":"string","description":"Channel creation datetime"},"current_limit":{"type":"string","description":"Meta's number current limit, can be NA or from TIER_50 to TIER_UNLIMITED"},"current_quality_rating":{"type":"string","description":"Meta's number current quality rating, can be NA, Low, Medium or High"},"current_quality_update_event":{"type":"string","description":"Meta's Last number quality update event","nullable":true},"is_oba":{"type":"boolean","description":"Indicates if business phone number is an Meta's [Official Business Account](https://developers.facebook.com/docs/whatsapp/overview/business-accounts/#official-business-account)."},"hub_status":{"type":"string","description":"**[Deprecated]** Current hub status of the channel. Use `availability_status` as the source of truth. Possible values are:\n- **live**: Number is live and connected and messaging is available.\n- **sandbox**: [deprecated] Number is available in sandbox environment.\n- **done**: [deprecated] Same as live.\n- **pending**: [deprecated] [on-prem] An on-prem stack is being setup.\n- **draft**: Stack is being setup for the number.\n- **pending_deletion**: Number will be terminated soon.\n- **unregistered**: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.\n- **unknown**: Unknown status. Needs to be checked by support.","deprecated":true},"availability_status":{"type":"string","enum":["setting_up","ready","error","cancelled","inactive"],"description":"Current availability status of the channel. This is the unified source of truth for channel availability. Possible values are:\n- **setting_up**: Channel is being set up\n- **ready**: Channel is ready and available for messaging\n- **error**: Channel has an error and is not available for messaging\n- **cancelled**: Channel is cancelled (cancelled_at is set, not yet terminated)\n- **inactive**: Channel is inactive (terminated_at is in the past)","nullable":true},"settings":{"description":"Channel settings","allOf":[{"$ref":"#/components/schemas/Settings"}]},"setup_info":{"description":"Channel setup information","allOf":[{"$ref":"#/components/schemas/ChannelSetupInfo"}]},"terminated_at":{"type":"string","description":"Channel termination datetime","nullable":true}},"additionalProperties":false},"Settings":{"type":"object","properties":{"tier":{"type":"string","description":"Billing tier","nullable":true},"is_allowed_to_send_outbound_message":{"type":"boolean","description":"[Internal Field]","deprecated":true},"data_localization_region":{"type":"string","description":"The region where your message data is stored on Meta infrastructure https://www.facebook.com/legal/Meta-Hosting-Terms-Cloud-API","nullable":true},"throughput":{"description":"Current throughput settings","anyOf":[{"$ref":"#/components/schemas/Throughput"},{"type":"object","nullable":true}]}},"additionalProperties":false},"Throughput":{"type":"object","properties":{"level":{"type":"string","description":"Current throughput level","nullable":true}},"additionalProperties":false},"ChannelSetupInfo":{"type":"object","properties":{"phone_name":{"type":"string","description":"Meta's phone name","nullable":true},"phone_number":{"type":"string","description":"Phone number","nullable":true},"certificate":{"type":"string","description":"Number certificate on Meta","nullable":true},"default_language":{"type":"string","description":"Default language for the number","nullable":true},"ivr":{"type":"boolean","description":"Does number have Interactive Voice Response?"},"verification_method":{"type":"string","enum":["voice","sms"],"description":"Methods to receive an OTP and verify the number ownership","nullable":true},"was_in_use":{"type":"boolean","description":"Was the WhatsApp number already in use?"}},"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/reactivate":{"post":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleChannelPublicPayloadOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Reactivate a previously cancelled channel.","description":"This endpoint works by revoking a previously requested cancellation for a specific channel.\nChannel should be paid by partner and not completely deleted.","operationId":"post_channel_management_docs_api_reactivate_channel"}}}}
```

## Retrieve whatsapp commerce settings for a specific channel

> 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>

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"PartnerGetWhatsappCommerceSettingsOut":{"type":"object","properties":{"data":{"type":"array","description":"Whatsapp commerce settings","items":{"$ref":"#/components/schemas/PartnerGetWhatsappCommerceSettingOut"}}},"additionalProperties":false},"PartnerGetWhatsappCommerceSettingOut":{"type":"object","properties":{"id":{"type":"string","description":"Phone number id on Meta"},"is_cart_enabled":{"type":"boolean","description":"When true, cart-related buttons appear in the conversation, catalog, and product details views"},"is_catalog_visible":{"type":"boolean","description":"When true, the catalog storefront icon and catalog-related buttons appear in conversation and business profile views"}},"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/whatsapp_commerce_settings":{"get":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerGetWhatsappCommerceSettingsOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Retrieve whatsapp commerce settings for a specific channel","description":"This endpoint allows partners to get whatsapp commerce settings for a specific number.\nIt acts as a proxy for Meta's API to retrieve commerce settings (like catalog visibility and cart enablement).\nMeta documentation: https://developers.facebook.com/documentation/business-messaging/whatsapp/catalogs/sell-products-and-services/set-commerce-settings/#get-commerce-settings","operationId":"get_channel_management_docs_api_get_whatsapp_commerce_settings_by_partner"}}}}
```

## Update whatsapp commerce settings for a specific channel

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

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"DefaultHttpOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"}},"required":["meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"PartnerWhatsappCommerceSettingsIn":{"type":"object","properties":{"is_cart_enabled":{"type":"boolean","description":"When true, cart-related buttons appear in the conversation, catalog, and product details views"},"is_catalog_visible":{"type":"boolean","description":"When true, the catalog storefront icon and catalog-related buttons appear in conversation and business profile views"}},"required":["is_cart_enabled","is_catalog_visible"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/whatsapp_commerce_settings":{"post":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Update whatsapp commerce settings for a specific channel","description":"This endpoint allows partners to update whatsapp commerce settings for a specific number.","operationId":"post_channel_management_docs_api_update_whatsapp_commerce_settings_by_partner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerWhatsappCommerceSettingsIn"}}}}}}}}
```

## Request cancellation for a specific channel

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

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"SingleChannelPublicPayloadOutLegacy":{"type":"object","properties":{"status":{"type":"string","enum":["created","unverified","verified","ready","transferred","modified","imported","new_name_requested","certificate_declined","consents_signed","error","porting_ready","ready_for_migration","waiting_for_migration_code","migration_code_requested","migration_verified","unregistered","removed"],"description":"Current status of the channel. Possible values are:\n- **created**: The channel is created and process for onboarding is started.\n- **unverified**: The channel is submitted to Meta and waiting for them to verify the display name.\n- **verified**: The channel display name is verified by Meta.\n- **ready**: The channel onboarding is completed and can be used for sending and receiving messages.\n- **transferred**: The channel is transferred to another BSP and 360dialog does not have access to it.\n- **modified**: [deprecated] When a channel name is updated.\n- **imported**: [deprecated]\n- **new_name_requested**: A new display name is requested for the channel and waiting for Meta's approval.\n- **certificate_declined**: The channel display name is rejected by Meta.\n- **consents_signed**: [deprecated]\n- **error**: Channel setup is failed for any reason and channel can not be used for messaging.\n- **porting_ready**: [deprecated]\n- **ready_for_migration**: [deprecated] A new channel is created to migrate a phone number from another BSP to 360dialog.\n- **waiting_for_migration_code**: [deprecated] Channel migration is initiated and next step is requesting a migration code from Meta.\n- **migration_code_requested**: [deprecated] Channel migration code is requested from Meta.\n- **migration_verified**: [deprecated] Channel migration is verified.\n- **unregistered**: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.\n- **removed**: 360dialog does not have access to the number on Meta."},"id":{"type":"string","description":"Channel ID"},"cancelled_at":{"type":"string","description":"Channel cancellation datetime","nullable":true},"client_id":{"type":"string","description":"Client ID that is the owner of the channel"},"created_at":{"type":"string","description":"Channel creation datetime"},"current_limit":{"type":"string","description":"Meta's number current limit, can be NA or from TIER_50 to TIER_UNLIMITED"},"current_quality_rating":{"type":"string","description":"Meta's number current quality rating, can be NA, Low, Medium or High"},"current_quality_update_event":{"type":"string","description":"Meta's Last number quality update event","nullable":true},"is_oba":{"type":"boolean","description":"Indicates if business phone number is an Meta's [Official Business Account](https://developers.facebook.com/docs/whatsapp/overview/business-accounts/#official-business-account)."},"hub_status":{"type":"string","description":"**[Deprecated]** Current hub status of the channel. Use `availability_status` as the source of truth. Possible values are:\n- **live**: Number is live and connected and messaging is available.\n- **sandbox**: [deprecated] Number is available in sandbox environment.\n- **done**: [deprecated] Same as live.\n- **pending**: [deprecated] [on-prem] An on-prem stack is being setup.\n- **draft**: Stack is being setup for the number.\n- **pending_deletion**: Number will be terminated soon.\n- **unregistered**: [deprecated] [on-prem] On-prem stack health has become unregistered and needs to be re-registered.\n- **unknown**: Unknown status. Needs to be checked by support.","deprecated":true},"availability_status":{"type":"string","enum":["setting_up","ready","error","cancelled","inactive"],"description":"Current availability status of the channel. This is the unified source of truth for channel availability. Possible values are:\n- **setting_up**: Channel is being set up\n- **ready**: Channel is ready and available for messaging\n- **error**: Channel has an error and is not available for messaging\n- **cancelled**: Channel is cancelled (cancelled_at is set, not yet terminated)\n- **inactive**: Channel is inactive (terminated_at is in the past)","nullable":true},"settings":{"description":"Channel settings","allOf":[{"$ref":"#/components/schemas/Settings"}]},"setup_info":{"description":"Channel setup information","allOf":[{"$ref":"#/components/schemas/ChannelSetupInfo"}]},"terminated_at":{"type":"string","description":"Channel termination datetime","nullable":true},"account_mode":{"type":"string","description":"[Deprecated] Can be live or sandbox","deprecated":true},"billing_started_at":{"type":"string","description":"[Deprecated]","deprecated":true,"nullable":true},"is_migrated":{"type":"boolean","description":"[Internal Field]","deprecated":true},"has_inbox":{"type":"boolean","description":"[Internal Field]","deprecated":true,"nullable":true},"version":{"type":"integer","description":"[Deprecated]","deprecated":true}},"additionalProperties":false},"Settings":{"type":"object","properties":{"tier":{"type":"string","description":"Billing tier","nullable":true},"is_allowed_to_send_outbound_message":{"type":"boolean","description":"[Internal Field]","deprecated":true},"data_localization_region":{"type":"string","description":"The region where your message data is stored on Meta infrastructure https://www.facebook.com/legal/Meta-Hosting-Terms-Cloud-API","nullable":true},"throughput":{"description":"Current throughput settings","anyOf":[{"$ref":"#/components/schemas/Throughput"},{"type":"object","nullable":true}]}},"additionalProperties":false},"Throughput":{"type":"object","properties":{"level":{"type":"string","description":"Current throughput level","nullable":true}},"additionalProperties":false},"ChannelSetupInfo":{"type":"object","properties":{"phone_name":{"type":"string","description":"Meta's phone name","nullable":true},"phone_number":{"type":"string","description":"Phone number","nullable":true},"certificate":{"type":"string","description":"Number certificate on Meta","nullable":true},"default_language":{"type":"string","description":"Default language for the number","nullable":true},"ivr":{"type":"boolean","description":"Does number have Interactive Voice Response?"},"verification_method":{"type":"string","enum":["voice","sms"],"description":"Methods to receive an OTP and verify the number ownership","nullable":true},"was_in_use":{"type":"boolean","description":"Was the WhatsApp number already in use?"}},"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/cancellation_request":{"post":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleChannelPublicPayloadOutLegacy"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"}},"tags":["Channel Management"],"summary":"Request cancellation for a specific channel","description":"The channel will be marked for cancellation and will be deactivated at the end of the month.","operationId":"post_channel_management_docs_api_cancellation_request"}}}}
```

## Enable local storage for a specific channel

> 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/>

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"DefaultHttpOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"}},"required":["meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"ChannelLocalStorageIn":{"type":"object","properties":{"data_localization_region":{"type":"string","enum":["AU","ID","IN","JP","SG","KR","DE","CH","GB","BR","BH","ZA","AE","CA"],"description":"The region for channel to store messaging data on Meta infrastructure"}},"required":["data_localization_region"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/enable_local_storage":{"post":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Server error"}},"tags":["Channel Management"],"summary":"Enable local storage for a specific channel","description":"This endpoint allows partners to enable local storage for a channel.\nCloud API Local Storage gives you the option to control where your message data is stored at rest.\nMeta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/overview/local-storage/","operationId":"post_channel_management_docs_api_enable_local_storage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelLocalStorageIn"}}}}}}}}
```

## Disable local storage for a specific channel

> 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/>

```json
{"openapi":"3.1.0","info":{"title":"Partners V2 API","version":"2.0.0"},"tags":[{"name":"Channel Management","description":"Endpoints for managing channels (phone numbers) and their settings"}],"servers":[{"description":"Production Server","url":"https://hub.360dialog.io"}],"security":[{"PartnerApiKeyV2":[]},{"Bearer":[]}],"components":{"securitySchemes":{"PartnerApiKeyV2":{"type":"apiKey","name":"X-API-Key","in":"header","description":"API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method."},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Token obtained via /api/v2/token endpoint."}},"schemas":{"DefaultHttpOut":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/_Meta"},"status_code":{"type":"integer"}},"required":["meta","status_code"],"additionalProperties":false},"_Meta":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultValidationError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/MetaSchemaErrorWithDetails"}]}},"required":["meta"],"additionalProperties":false},"MetaSchemaErrorWithDetails":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"},"details":{"type":"object","description":"Additional error data","additionalProperties":{}}},"required":["developer_message","http_code","success"],"additionalProperties":false},"DefaultHttpError":{"type":"object","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/_MetaSchemaError"}]}},"required":["meta"],"additionalProperties":false},"_MetaSchemaError":{"type":"object","properties":{"developer_message":{"type":"string"},"http_code":{"type":"integer"},"success":{"type":"boolean"},"360dialog_trace_id":{"type":"string","description":"Trace ID for debugging purposes"}},"required":["developer_message","http_code","success"],"additionalProperties":false}}},"paths":{"/api/v2/partners/{partner_id}/clients/{client_id}/channels/{channel_id}/control/disable_local_storage":{"post":{"parameters":[{"in":"path","name":"client_id","description":"The ID of the client.","schema":{"type":"string"},"required":true},{"in":"path","name":"partner_id","description":"The ID of the partner.","schema":{"type":"string"},"required":true},{"in":"path","name":"channel_id","description":"The ID of the channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpOut"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValidationError"}}},"description":"Wrong payload"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Not found"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultHttpError"}}},"description":"Server error"}},"tags":["Channel Management"],"summary":"Disable local storage for a specific channel","description":"This endpoint allows partners to disable local storage for a channel.\nCloud API Local Storage gives you the option to control where your message data is stored at rest.\nMeta documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/overview/local-storage/","operationId":"post_channel_management_docs_api_disable_local_storage"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.360dialog.com/partner/partner-api/api-reference/channel-management.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.