openapi: 3.2.0 info: title: Provisioning WhatsApp Senders API description: A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users. version: 1.2.117 servers: - url: https://provisioning.api.sinch.com description: Production server security: - BasicAuth: [] BearerAuth: [] OAuth2Production: [] tags: - name: WhatsApp Senders description: A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users. paths: /v1/projects/{projectId}/whatsapp/senders: get: description: Returns a paginated list of senders for the specified project. If no page token is supplied then the first `50` will be returned. operationId: WhatsappSendersController_listSenders_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: pageToken required: false in: query schema: type: string description: The page token if retrieving the next page from a previous query. - name: pageSize required: false in: query schema: type: number minimum: 1 maximum: 100 description: The page size requested. - name: filterStates required: false in: query description: Optionally query for sender by states. x-enumDescriptions: ACTIVE: The sender identity is active and ready to dispatch messages. IN_PROGRESS: The configuration or provisioning sequence for the sender identity is currently in progress. INACTIVE: The sender identity exists within the system but is currently not active. PENDING_VERIFICATION: The sender identity awaits completion of the formal verification and compliance loop. SUSPENDED: The sender identity has been temporarily suspended due to administrative or policy restrictions. ERROR: The sender identity has encountered an operational failure and requires technical troubleshooting. schema: type: array items: $ref: '#/components/schemas/WhatsappSenderStatesEnum' - name: filterStatuses required: false in: query description: Optionally query for sender by statuses. x-enumDescriptions: DRAFT: The modifications to the sender identity are saved as a draft only. ERROR: The modifications to the sender identity failed and require technical troubleshooting or a manual retry. IN_PROGRESS: The modifications to the sender identity have been submitted and are still processing. MULTIPLE_WABA_ERROR: This status is deprecated and retained exclusively for backward compatibility layers. REJECTED: The modifications to the sender identity have been reviewed and rejected. schema: type: array items: $ref: '#/components/schemas/WhatsappSenderStatusesEnum' responses: '200': description: List of senders content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderListDto' examples: response: summary: List response description: "\n Response with senders.\n " value: totalSize: 2 pageSize: 50 senders: - id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us - id: cf11794a-6a5e-4a12-b103-da79bd378bf1 changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. invalid_page_token-1: summary: InvalidPageTokenError value: errorCode: invalid_page_token message: Invalid page token. resolution: The page token to use is provided in the previous query response, for new queries simply leave this field undefined. invalid_page_size-2: summary: InvalidPageSizeError value: errorCode: invalid_page_size message: Page size must be numeric. resolution: Use a integer value for pageSize parameter. invalid_filter_states-3: summary: InvalidFilterStatesError value: errorCode: invalid_filter_states message: Invalid filterStates. resolution: Verify that the filterStates used are supported by the Provisioning API. additionalInformation: supportedCodes: ACTIVE, IN_PROGRESS, INACTIVE, PENDING_VERIFICATION, SUSPENDED, ERROR invalid_filter_statuses-4: summary: InvalidFilterStatusesError value: errorCode: invalid_filter_statuses message: Invalid filter statuses. resolution: Verify that the filterStatuses used are supported by the Provisioning API. additionalInformation: supportedCodes: DRAFT, ERROR, IN_PROGRESS, REJECTED '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: List all senders in project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green post: callbacks: Comment: '{$request.body#webhooks.target}': post: summary: Comment on sender description: "\n Received when a comment has been added to the sender.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_COMMENT_ADDED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload - comment example: type: WHATSAPP_SENDER_COMMENT_ADDED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: INACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us comment: Example comment responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Active: '{$request.body#webhooks.target}': post: summary: Sender completed description: "\n Received when a Sender is completed and ready for use.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_ACTIVE`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_ACTIVE payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Inactive: '{$request.body#webhooks.target}': post: summary: Sender inactive description: "\n Received when a sender is inactivated.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_INACTIVE`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_INACTIVE payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: INACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. PendingVerification: '{$request.body#webhooks.target}': post: summary: Sender in pending verification description: "\n Received when a sender is in pending verification.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_PENDING_VERIFICATION`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_PENDING_VERIFICATION payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: PENDING_VERIFICATION details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Rejected: '{$request.body#webhooks.target}': post: summary: Sender in rejected description: "\n Received when a sender is rejected.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_REJECTED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_REJECTED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 changes: status: REJECTED details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Error: '{$request.body#webhooks.target}': post: summary: Sender in error description: "\n Received when a sender has error.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_ERROR`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_ERROR payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 changes: status: ERROR details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png errorReason: Reach out to support at support@sinch.com metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. DailyLimitChanged: '{$request.body#webhooks.target}': post: summary: Daily limit changed for Sender deprecated: true description: "\n Received when a daily limit for sender is changed.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_DAILY_LIMIT_CHANGED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_DAILY_LIMIT_CHANGED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN dailyLimit: TIER_100K bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. QualityRatingChanged: '{$request.body#webhooks.target}': post: summary: Quality rating changed for Sender description: "\n Received when a quality rating for sender is changed.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_QUALITY_RATING_CHANGED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_QUALITY_RATING_CHANGED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: YELLOW bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Deleted: '{$request.body#webhooks.target}': post: summary: Sender deleted description: "\n Received when a sender has been deleted.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_DELETED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_DELETED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 region: UNRECOGNIZED metaLocalStorage: UNRECOGNIZED cloudApi: false businessManager: SINCH_UK compatibleRegions: [] responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. DisplayNameUpdated: '{$request.body#webhooks.target}': post: summary: Sender display name updated description: "\n Received when a sender display name is updated.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_DISPLAY_NAME_UPDATED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_DISPLAY_NAME_UPDATED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. UsernameUpdated: '{$request.body#webhooks.target}': post: summary: Sender username updated description: "\n Received when a sender username is updated.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_USERNAME_UPDATED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_USERNAME_UPDATED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. description: 'Creates a sender for a project. The possible combinations of region, business manager and hosting type are the following | Region | | SINCH_BR | SINCH_MX | SINCH_UK | | --------- | -- | --- | --- | --- | | BR | Embedded (ES) | ✅ Supported | ✅ Supported | ❌ Unsupported | | | Partner-initiated | ✅ Supported | ✅ Supported | ❌ Unsupported | | EU | Embedded (ES) | ❌ Unsupported | ❌ Unsupported | ✅ Supported | | | Partner-initiated | ❌ Unsupported | ❌ Unsupported | ✅ Supported | | US | Embedded (ES) | ✅ Supported | ✅ Supported | ✅ Supported | | | Partner-initiated | ✅ Supported | ✅ Supported | ✅ Supported |' operationId: WhatsappSendersController_createSender_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string requestBody: required: true description: Sender data content: application/json: schema: anyOf: - $ref: '#/components/schemas/WhatsappSenderInputEsDto' - $ref: '#/components/schemas/WhatsappInputSenderPhoneProvisioningDto' - $ref: '#/components/schemas/WhatsappInputSenderPartnerInitiatedDto' - $ref: '#/components/schemas/WhatsappSenderInputDtoDeprecated' examples: es: summary: Body request for ES description: "\n Example body request to create an ES.\n " value: region: EU metaLocalStorage: DE wabaId: '11111111111111' phoneNumberId: '222222222222222' authenticationCode: 123asdf123 phoneProvisioning: summary: Body request for new-number sender flow description: "\n Example body request to create a sender with provisioned phone number.\n " value: details: countryCode: '49' phoneNumber: '1701234567' displayName: Demo sender partnerInitiated: summary: Body request for Partner Initiated Sender description: "\n Example body request to create a partner-initiated sender.\n " value: region: EU metaLocalStorage: DE phoneNumberProvider: CUSTOMER details: countryCode: '48' phoneNumber: '777777777' displayName: Test name description: Test description vertical: EDUCATION email: test@test.com address: Test address websiteOne: https://example-1.com about: Test about photoUrl: https://example.com/photos/1.png esWithFacebookToken: summary: Body request for ES with Facebook token [Deprecated] description: "\n Example body request to create an ES. [Deprecated]\n " value: region: EU metaLocalStorage: DE wabaId: '11111111111111' phoneNumberId: '222222222222222' facebookAccessToken: FACEBOOK_TOKEN name: Example name details: displayName: Test name description: Test description vertical: EDUCATION email: test@test.com address: Test address websiteOne: https://example-1.com about: Test about photoUrl: https://example.com/photos/1.png esWithFacebookCode: summary: Body request for ES with Facebook code [Deprecated] description: "\n Example body request to create an ES. [Deprecated]\n " value: region: EU metaLocalStorage: DE wabaId: '11111111111111' phoneNumberId: '222222222222222' facebookCode: FACEBOOK_CODE name: Example name details: displayName: Test name description: Test description vertical: EDUCATION email: test@test.com address: Test address websiteOne: https://example-1.com about: Test about photoUrl: https://example.com/photos/1.png responses: '201': description: Sender content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderDto' examples: response: summary: Create response description: "\n Response when successfully creating a sender.\n " value: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: invalid_input-0: summary: InvalidInputError value: errorCode: invalid_input message: Invalid input. resolution: Correct the validation errors and submit again. additionalInformation: validationErrors: - details should not be null or undefined project_not_initialized-1: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. invalid_facebook_token-2: summary: InvalidFacebookTokenError value: errorCode: invalid_facebook_token message: Facebook token is invalid or has expired resolution: Check that token is correct, or create a new one and try again. invalid_business_manager-3: summary: InvalidBusinessManagerError value: errorCode: invalid_business_manager message: Invalid business manager. resolution: Check that business manager is correct for project. invalid_business_manager_for_environment-4: summary: InvalidBusinessManagerForEnvironmentError value: errorCode: invalid_business_manager_for_environment message: Invalid business manager for environment. resolution: Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK. file_invalid_mime_type-5: summary: FileInvalidMimeTypeError value: errorCode: file_invalid_mime_type message: 'details.photoUrl: invalid file mime type.' resolution: 'Try again with supported mime types: image/jpeg, image/png, image/webp.' invalid_payload-6: summary: InvalidPayloadError value: errorCode: invalid_payload message: Invalid payload. resolution: Correct payload and submit again. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_found-0: summary: ProjectNotFoundError value: errorCode: project_not_found message: Project not found. resolution: Verify that the projectId is correct. '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: account_data_is_corrupt-0: summary: AccountDataIsCorruptError value: errorCode: account_data_is_corrupt message: Account data is corrupt. resolution: Please contact support. wrong_waba_id-1: summary: WrongWabaIdError value: errorCode: wrong_waba_id message: Different wabaId already exists for sub account / project. resolution: Please check if the WhatsApp Business Account is correct, or don't provide the WhatsApp Business Account in the request for this project. not_found_waba_id-2: summary: NotFoundWabaIdError value: errorCode: not_found_waba_id message: Not found wabaId. resolution: Verify that exist any WhatsApp Business Account for sub account / project. too_many_waba_id-3: summary: TooManyWabaIdError value: errorCode: too_many_waba_id message: Too many wabaId. resolution: We can't automatically select WhatsApp Business Account for this project, please provide WhatsApp Business Account in the request. waba_id_used-4: summary: WabaIdUsedError value: errorCode: waba_id_used message: WabaId is used. resolution: WhatsApp Business Account is already used in another project. Use another id or create the sender under the correct project. wrong_business_manager-5: summary: WrongBusinessManagerError value: errorCode: wrong_business_manager message: Different business manager already exists for sub account / project. resolution: Please check if the Business Manager is correct, or don't provide the Business Manager in the request for this project. used_phone_number_id-6: summary: UsedPhoneNumberIdError value: errorCode: used_phone_number_id message: Used phoneNumberId. resolution: PhoneNumberId is used. Choose another one. provisioned_phone_number_id-7: summary: ProvisionedPhoneNumberIdError value: errorCode: provisioned_phone_number_id message: Provisioned phoneNumberId. resolution: PhoneNumberId is provisioned. Choose another one. all_phone_number_id_provisioned-8: summary: AllPhoneNumberIdProvisionedError value: errorCode: all_phone_number_id_provisioned message: All phoneNumberId are provisioned. resolution: All phoneNumberId are provisioned. Add another one. invalid_waba_id_or_phone_number_id_for_region-9: summary: InvalidWabaIdOrPhoneNumberIdForRegionError value: errorCode: invalid_waba_id_or_phone_number_id_for_region message: Invalid wabaId or phoneNumberId for region. resolution: Please check if the WhatsApp Business Account, phone number id and region are correct. file_not_found-10: summary: FileNotFoundError value: errorCode: file_not_found message: 'details.photoUrl: file not found.' resolution: Verify that the url is correct. file_size_too_large-11: summary: FileSizeTooLargeError value: errorCode: file_size_too_large message: 'details.photoUrl: file size is too large.' resolution: Try again with a smaller file. Max size for `image/jpeg` is 5MB. file_has_wrong_dimensions-12: summary: FileHasWrongDimensionsError value: errorCode: file_has_wrong_dimensions message: 'details.photoUrl: image has wrong dimensions.' resolution: 'Try again with image dimensions: min 192 x 192 px & max 640 x 640 px.' file_unexpected_error-13: summary: FileUnexpectedErrorError value: errorCode: file_unexpected_error message: 'details.photoUrl: file unexpected error.' resolution: The file cannot be handled properly. Please try with another one. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: facebook_Request_limit_reached-0: summary: FacebookRequestLimitReachedError value: errorCode: facebook_Request_limit_reached message: Facebook request limit reached. resolution: Please try again later. log_in_facebook_required-1: summary: LogInFacebookRequiredError value: errorCode: log_in_facebook_required message: Log in to facebook required. resolution: Log in to www.facebook.com and follow the instructions given. internal_error-2: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Create sender for project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}: get: description: Returns a sender for a project. operationId: WhatsappSendersController_get_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string responses: '200': description: Sender content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderDto' examples: response: summary: Get response description: "\n Response with a sender.\n " value: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Get sender for project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green delete: description: Marks a sender for removal. Once requested the sender will be active for 30 days to send final messages. After 30 days it will be removed. operationId: WhatsappSendersController_delete_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string responses: '204': description: Sender deleted '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_already_deleted-0: summary: SenderAlreadyDeletedError value: errorCode: sender_already_deleted message: A sender has been deleted within 30 days. resolution: Wait the required time. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Delete sender for project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green patch: callbacks: Comment: '{$request.body#webhooks.target}': post: summary: Comment on sender description: "\n Received when a comment has been added to the sender.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_COMMENT_ADDED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload - comment example: type: WHATSAPP_SENDER_COMMENT_ADDED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: INACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us comment: Example comment responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Active: '{$request.body#webhooks.target}': post: summary: Sender completed description: "\n Received when a Sender is completed and ready for use.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_ACTIVE`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_ACTIVE payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Inactive: '{$request.body#webhooks.target}': post: summary: Sender inactive description: "\n Received when a sender is inactivated.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_INACTIVE`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_INACTIVE payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: INACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. PendingVerification: '{$request.body#webhooks.target}': post: summary: Sender in pending verification description: "\n Received when a sender is in pending verification.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_PENDING_VERIFICATION`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_PENDING_VERIFICATION payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: PENDING_VERIFICATION details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Rejected: '{$request.body#webhooks.target}': post: summary: Sender in rejected description: "\n Received when a sender is rejected.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_REJECTED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_REJECTED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 changes: status: REJECTED details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Error: '{$request.body#webhooks.target}': post: summary: Sender in error description: "\n Received when a sender has error.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_ERROR`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_ERROR payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 changes: status: ERROR details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png errorReason: Reach out to support at support@sinch.com metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. DailyLimitChanged: '{$request.body#webhooks.target}': post: summary: Daily limit changed for Sender deprecated: true description: "\n Received when a daily limit for sender is changed.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_DAILY_LIMIT_CHANGED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_DAILY_LIMIT_CHANGED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN dailyLimit: TIER_100K bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. QualityRatingChanged: '{$request.body#webhooks.target}': post: summary: Quality rating changed for Sender description: "\n Received when a quality rating for sender is changed.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_QUALITY_RATING_CHANGED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_QUALITY_RATING_CHANGED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: YELLOW bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. Deleted: '{$request.body#webhooks.target}': post: summary: Sender deleted description: "\n Received when a sender has been deleted.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_DELETED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_DELETED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 region: UNRECOGNIZED metaLocalStorage: UNRECOGNIZED cloudApi: false businessManager: SINCH_UK compatibleRegions: [] responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. DisplayNameUpdated: '{$request.body#webhooks.target}': post: summary: Sender display name updated description: "\n Received when a sender display name is updated.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_DISPLAY_NAME_UPDATED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_DISPLAY_NAME_UPDATED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. UsernameUpdated: '{$request.body#webhooks.target}': post: summary: Sender username updated description: "\n Received when a sender username is updated.\n " parameters: - in: header name: x-sinch-webhook-signature schema: type: string format: SHA256-hash example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8= - in: header name: x-sinch-webhook-signature-algorithm schema: type: string const: HmacSHA256 x-enumDescriptions: HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity. uniqueItems: false example: HmacSHA256 - in: header name: x-sinch-webhook-signature-nonce schema: type: string example: 01EAW2BNWCG9DC13RS582V0ZQ3 - in: header name: x-sinch-webhook-signature-timestamp schema: type: string format: timestamp example: '1592227387' requestBody: content: application/json: schema: type: object properties: type: description: Type of event, in this case `WHATSAPP_SENDER_USERNAME_UPDATED`. type: string payload: description: Sender at time of callback. allOf: - $ref: '#/components/schemas/WhatsappSenderDto' comment: description: Comment for sender. type: string required: - type - payload example: type: WHATSAPP_SENDER_USERNAME_UPDATED payload: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us responses: '200': description: Response to callback will be ignored. The call will retry if unsuccessful. description: 'Updates a sender in project. Pending sender updates are tracked in "changes", except "displayName", which is tracked in "metadata.displayName".' operationId: WhatsappSendersController_update_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string requestBody: required: true description: Supported sender fields to update content: application/json: schema: $ref: '#/components/schemas/WhatsappUpdateSenderInputDto' examples: default: summary: Body request description: "\n Example body request to update a sender.\n " value: details: displayName: Test name update description: Test description update email: null address: null websiteTwo: https://example-2.com about: Test about update photoUrl: https://example.com/photos/2.png username: summary: Body request with username description: "\n Example body request to update a sender with username.\n " value: details: username: Username responses: '200': description: Updated sender in project content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderDto' examples: response: summary: Update response description: "\n Response when successfully update a sender.\n " value: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 state: ACTIVE changes: status: IN_PROGRESS details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png details: displayName: Test name description: Test description vertical: PROFESSIONAL_SERVICES email: test@test.com address: Test address about: Test about websiteOne: https://example-1.com photoUrl: https://example.com/photos/1.png metadata: displayName: value: New Display Name status: PENDING created: '2023-01-19T13:11:08.204Z' modified: '2023-01-19T13:11:08.204Z' region: EU metaLocalStorage: DE conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1 conversationApiAppDetails: id: 4CF9CE97504C4A468F4610919D17ECC1 projectId: ea026751-3edf-40a9-ad93-1b382bd60a78 region: EU channelStatus: ACTIVE maxTps: 10 qualityRating: GREEN bearerToken: aaaaAAAA.bbbbBBBB.ccccCCCC cloudApi: true countryCode: '48' phoneNumber: '777777777' numberProvider: CUSTOMER businessManager: SINCH_UK compatibleRegions: - eu - us '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: invalid_input-0: summary: InvalidInputError value: errorCode: invalid_input message: Invalid input. resolution: Correct the validation errors and submit again. additionalInformation: validationErrors: - details.displayName must be a string - details.displayName must be longer than or equal to 1 characters - details.displayName must be shorter than or equal to 128 characters - details.displayName should not be equal to null project_not_initialized-1: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. sender_username_not_available-2: summary: SenderUsernameNotAvailableError value: errorCode: sender_username_not_available message: Sender username is not available. resolution: Choose another username and try again. sender_phone_number_not_registered_with_meta_cloud_api-3: summary: SenderPhoneNumberNotRegisteredWithMetaCloudApiError value: errorCode: sender_phone_number_not_registered_with_meta_cloud_api message: Sender phone number is not registered with Cloud API. resolution: Register the phone number with WhatsApp Cloud API and try again. no_fields_to_update-4: summary: NoFieldsToUpdateError value: errorCode: no_fields_to_update message: No fields to be updated. resolution: Supply at least one field to be updated. file_invalid_mime_type-5: summary: FileInvalidMimeTypeError value: errorCode: file_invalid_mime_type message: 'details.photoUrl: invalid file mime type.' resolution: 'Try again with supported mime types: image/jpeg, image/png, image/webp.' invalid_payload-6: summary: InvalidPayloadError value: errorCode: invalid_payload message: Invalid payload. resolution: Correct payload and submit again. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_updatable-0: summary: SenderNotUpdatableError value: errorCode: sender_not_updatable message: Sender is not updatable. resolution: 'Updates are only supported by senders with state: ACTIVE.' sender_changes_not_updatable-1: summary: SenderChangesNotUpdatableError value: errorCode: sender_changes_not_updatable message: Sender is not updatable. resolution: 'Updates are only supported by senders changes with status: DRAFT, REJECTED.' sender_display_name_update_not_allowed-2: summary: SenderDisplayNameUpdateNotAllowedError value: errorCode: sender_display_name_update_not_allowed message: Sender display name update is not allowed. resolution: Sender display name cannot be updated while it is being reviewed. Please try again later. sender_username_update_not_available-3: summary: SenderUsernameUpdateNotAvailableError value: errorCode: sender_username_update_not_available message: Sender username update is not available. resolution: Only "ACTIVE" senders can have their username updated. file_not_found-4: summary: FileNotFoundError value: errorCode: file_not_found message: 'details.photoUrl: file not found.' resolution: Verify that the url is correct. file_size_too_large-5: summary: FileSizeTooLargeError value: errorCode: file_size_too_large message: 'details.photoUrl: file size is too large.' resolution: Try again with a smaller file. Max size for `image/jpeg` is 5MB. file_has_wrong_dimensions-6: summary: FileHasWrongDimensionsError value: errorCode: file_has_wrong_dimensions message: 'details.photoUrl: image has wrong dimensions.' resolution: 'Try again with image dimensions: min 192 x 192 px & max 640 x 640 px.' file_unexpected_error-7: summary: FileUnexpectedErrorError value: errorCode: file_unexpected_error message: 'details.photoUrl: file unexpected error.' resolution: The file cannot be handled properly. Please try with another one. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Updates a sender in project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}/activities: get: description: Paginated list of activities for sender. Ordered from the most recent one to the oldest one. operationId: WhatsappSendersController_listActivities_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string - name: pageToken required: false in: query schema: type: string description: The page token if retrieving the next page from a previous query. - name: pageSize required: false in: query schema: type: number minimum: 1 maximum: 100 description: The page size requested. responses: '200': description: Recent activities on sender content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderNotificationListDto' examples: response: summary: List sender activities response description: "\n Response for all sender activities.\n " value: totalSize: 2 pageSize: 50 notifications: - type: CREATED created: '2023-01-19T13:11:08.204Z' author: Provisioning API user - type: COMMENT_ADDED created: '2023-01-19T13:11:08.204Z' comment: Example comment author: Provisioning API user '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. invalid_page_token-1: summary: InvalidPageTokenError value: errorCode: invalid_page_token message: Invalid page token. resolution: The page token to use is provided in the previous query response, for new queries simply leave this field undefined. invalid_page_size-2: summary: InvalidPageSizeError value: errorCode: invalid_page_size message: Page size must be numeric. resolution: Use a integer value for pageSize parameter. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Lists activities on sender tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}/changes: delete: description: Delete pending or rejected changes to a sender. operationId: WhatsappSendersController_deleteChanges_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string responses: '204': description: Sender changes deleted '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_changes_not_found-0: summary: SenderChangesNotFoundError value: errorCode: sender_changes_not_found message: Sender changes not found. resolution: Verify that the parameters are correct. '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_changes_not_deletable-0: summary: SenderChangesNotDeletableError value: errorCode: sender_changes_not_deletable message: Sender changes is not deletable. resolution: Only DRAFT, REJECTED, ERROR senders changes can be marked for deletion. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Delete pending or rejected changes to a sender tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}/comments: post: description: Creates a comment for a sender in project. operationId: WhatsappSendersController_createComment_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string requestBody: required: true description: Comment data content: application/json: schema: $ref: '#/components/schemas/WhatsappCommentInputDto' examples: input: summary: Body request description: "\n Example body request to create a comment.\n " value: comment: Example comment. responses: '201': description: Created comment for a sender in project content: application/json: schema: $ref: '#/components/schemas/WhatsappCommentDto' examples: created: summary: Create response description: "\n Response when successfully creating a comment.\n " value: type: CREATED comment: Example comment created: '2023-01-19T13:11:08.204Z' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. invalid_input-1: summary: InvalidInputError value: errorCode: invalid_input message: Invalid input. resolution: Correct the validation errors and submit again. additionalInformation: validationErrors: - comment must be longer than or equal to 1 characters invalid_payload-2: summary: InvalidPayloadError value: errorCode: invalid_payload message: Invalid payload. resolution: Correct payload and submit again. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Creates a comment for a sender in project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}/register: post: description: Triggers sender registration with the requested method. An OTP code will be sent over the requested method that will need to be used in the Verify sender endpoint. operationId: WhatsappSendersController_register_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string requestBody: required: true description: Sender register data content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderInputRegisterDto' examples: input: summary: Body request description: "\n Example body request to register.\n " value: method: SMS responses: '200': content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderRegisterDto' examples: response: summary: Register response description: "\n Response when successfully register a sender.\n " value: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 method: SMS accepted: '2023-01-19T13:11:08.204Z' verificationCodeSent: true phoneAlreadyRegistered: summary: Phone number already registered description: "\n Response when the phone number is already registered.\n " value: id: cf11794a-6a5e-4a12-b103-da79bd378bf1 method: SMS accepted: '2023-01-19T13:11:08.204Z' verificationCodeSent: false description: '' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: invalid_input-0: summary: InvalidInputError value: errorCode: invalid_input message: Invalid input. resolution: Correct the validation errors and submit again. additionalInformation: validationErrors: - 'method must be one of the following values: SMS, VOICE' project_not_initialized-1: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. sender_request_code_failed-2: summary: SenderRequestCodeFailedError value: errorCode: sender_request_code_failed message: Request code failed. resolution: Request code failed. Please try again in some time. invalid_payload-3: summary: InvalidPayloadError value: errorCode: invalid_payload message: Invalid payload. resolution: Correct payload and submit again. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: not_allowed_register-0: summary: NotAllowedRegisterError value: errorCode: not_allowed_register message: Sender not allowed to be registered. resolution: Only "PENDING_VERIFICATION" sender can be registered. sender-number-not-approved-for-enterprise-1: summary: SenderNumberNotApprovedForEnterpriseError value: errorCode: sender-number-not-approved-for-enterprise message: Sender number not approved for enterprise. resolution: This number has not been approved for an enterprise. Please contact support for more info. '429': description: TooManyRequests content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender-register-too-many-requests-0: summary: SenderRegisterTooManyRequestsError value: errorCode: sender-register-too-many-requests message: Sender register too many requests. resolution: Register sender request limits reached. Please try again later. sender-already-registered-1: summary: SenderAlreadyRegisteredError value: errorCode: sender-already-registered message: Sender already registered. resolution: Verify that the parameters are correct. too_many_invalid_verification_codes-2: summary: TooManyInvalidVerificationCodesError value: errorCode: too_many_invalid_verification_codes message: Too many invalid verification codes. resolution: You've tried too many invalid verification codes. Please try again later. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Register sender for project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}/suggestedUsernames: get: description: Retrieves a list of suggested usernames for the specified sender. operationId: WhatsappSendersController_getSuggestedUsernames_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string responses: '200': description: Suggested usernames content: application/json: schema: $ref: '#/components/schemas/WhatsappSuggestedUsernamesDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: project_not_initialized-0: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Get suggested usernames for sender tags: - WhatsApp Senders x-badges: - name: GA position: after color: green /v1/projects/{projectId}/whatsapp/senders/{senderId}/verify: post: description: Verify sender with the OTP received after triggering registration. operationId: WhatsappSendersController_verify_v1 parameters: - name: projectId required: true in: path description: The unique ID of the project. You can find this on the Sinch Dashboard. schema: type: string - name: senderId required: true in: path description: The unique ID of the sender. schema: type: string requestBody: required: true description: Sender verification data content: application/json: schema: $ref: '#/components/schemas/WhatsappSenderInputVerifyDto' examples: input: summary: Body request description: "\n Example body request to verify a sender.\n " value: code: '123456' responses: '204': description: Sender verified '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: invalid_input-0: summary: InvalidInputError value: errorCode: invalid_input message: Invalid input. resolution: Correct the validation errors and submit again. additionalInformation: validationErrors: - code must be a string - code must be exactly 6 characters project_not_initialized-1: summary: ProjectNotInitializedError value: errorCode: project_not_initialized message: Project not initialized for WhatsApp. resolution: Verify that the project ID is correct and that it has been onboarded for WhatsApp. invalid_payload-2: summary: InvalidPayloadError value: errorCode: invalid_payload message: Invalid payload. resolution: Correct payload and submit again. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: unauthorized_error-0: summary: UnauthorizedErrorError value: errorCode: unauthorized_error message: Unauthorized error. resolution: Verify that projectId is correct. '404': description: NotFound content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: sender_not_found-0: summary: SenderNotFoundError value: errorCode: sender_not_found message: Sender not found. resolution: Verify that the parameters are correct. '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: not_allowed_verify-0: summary: NotAllowedVerifyError value: errorCode: not_allowed_verify message: Sender not allowed to be verified. resolution: Only "PENDING_VERIFICATION" sender can be verified. wrong_otp-1: summary: WrongOtpError value: errorCode: wrong_otp message: Sender verification failed due to wrong OTP. resolution: Please make sure that the correct OTP code is entered. '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/WhatsappPapiErrorDto' examples: internal_error-0: summary: InternalErrorError value: errorCode: internal_error message: Internal server error. resolution: Please wait and try again, if the error persist please contact support. summary: Verify sender for project tags: - WhatsApp Senders x-badges: - name: GA position: after color: green components: schemas: WhatsappSenderMetadataFieldDto: type: object properties: value: type: string description: Requested value of the field. uniqueItems: false status: x-enumDescriptions: APPROVED: The profile field modification has been approved and applied. DEFERRED: The profile field modification has been deferred and will be evaluated later. DELETED: The profile field modification has been removed and is no longer active. EXPIRED: The profile field modification expired prior to completion. PENDING: The profile field modification is currently awaiting review or system processing. REJECTED: The profile field modification has been reviewed and rejected. RESERVED: The requested field parameter value is reserved but has not yet received final approval. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. UNSPECIFIED: The operational status of the field modification is unspecified. description: Current approval status of the field. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappWhatsAppSenderFieldUpdateStatusEnum' rejectionReason: type: string description: Reason for rejection if the field update was rejected. uniqueItems: false required: - status WhatsappSenderNotificationTypeEnum: type: string enum: - ACTIVE - COMMENT_ADDED - CREATED - DRAFT - EDITED - ERROR - IN_PROGRESS - INACTIVE - REGISTERED - REJECTED - VERIFIED WhatsappSenderMetadataDto: type: object properties: displayName: description: Approval status of the sender display name. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderMetadataFieldDto' username: description: Approval status of the sender username. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderMetadataFieldDto' WhatsappConversationApiAppDto: type: object properties: id: type: string description: ID of the app uniqueItems: false projectId: type: string description: ID of the app project uniqueItems: false region: x-enumDescriptions: BR: The application operates within the Brazil region. EU: The application operates within the Europe region. US: The application operates within the United States region. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: App region. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappConversationApiAppRegionsEnum' channelStatus: x-enumDescriptions: ACTIVE: The channel integration is active and operating as expected. FAILING: The channel integration is failing and requires manual attention or troubleshooting. PENDING: The channel integration setup or synchronization is pending completion. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Status of the channel credentials integration. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappConversationAppChannelIntegrationStatusEnum' required: - id - projectId - region WhatsappSenderInputMetaLocalStoragesEnum: type: string enum: - AE - AU - BH - BR - CA - CH - DE - GB - ID - IN - JP - KR - SG - US - ZA description: Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used. WhatsappCommentInputDto: type: object properties: comment: type: string minLength: 1 maxLength: 65535 uniqueItems: false required: - comment WhatsappSenderInputEsDto: type: object properties: region: x-enumDescriptions: BR: Specifies that the sender operations should be initialized within the Brazil region. EU: Specifies that the sender operations should be initialized within the Europe region. US: Specifies that the sender operations should be initialized within the United States region. description: Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputRegionEnum' metaLocalStorage: x-enumDescriptions: AE: Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates. AU: Specifies that Meta-managed user and compliance data should be stored within Australia. BH: Specifies that Meta-managed user and compliance data should be stored within Bahrain. BR: Specifies that Meta-managed user and compliance data should be stored within Brazil. CA: Specifies that Meta-managed user and compliance data should be stored within Canada. CH: Specifies that Meta-managed user and compliance data should be stored within Switzerland. DE: Specifies that Meta-managed user and compliance data should be stored within Germany. GB: Specifies that Meta-managed user and compliance data should be stored within the United Kingdom. ID: Specifies that Meta-managed user and compliance data should be stored within Indonesia. IN: Specifies that Meta-managed user and compliance data should be stored within India. JP: Specifies that Meta-managed user and compliance data should be stored within Japan. KR: Specifies that Meta-managed user and compliance data should be stored within South Korea. SG: Specifies that Meta-managed user and compliance data should be stored within Singapore. US: Specifies that Meta-managed user and compliance data should be stored within the United States. ZA: Specifies that Meta-managed user and compliance data should be stored within South Africa. description: Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum' wabaId: type: string description: WhatsApp Business Account that will be connected to the created sender. If left empty, we will try to find the WhatsApp Business Account using your projectId. uniqueItems: false phoneNumberId: type: string description: Phone number ID linked to the WhatsApp Business Account. uniqueItems: false businessManager: x-enumDescriptions: SINCH_BR: Instructs the interface layer to reference public onboarding documentation for the Brazil Meta Business Manager asset. SINCH_MX: Instructs the interface layer to reference public onboarding documentation for the Mexico Meta Business Manager asset. SINCH_UK: Instructs the interface layer to reference public onboarding documentation for the United Kingdom Meta Business Manager asset. description: Business manager. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum' authenticationCode: type: string minLength: 1 description: Single-use access code. uniqueItems: false required: - wabaId - phoneNumberId WhatsappCommentTypeEnum: type: string const: CREATED WhatsappSenderWhatsAppVerticalEnum: type: string enum: - ALCOHOL - AUTOMOTIVE - BEAUTY_SPA_SALON - CLOTHING_AND_APPAREL - EDUCATION - ENTERTAINMENT - EVENT_PLANNING_AND_SERVICE - FINANCE_AND_BANKING - FOOD_AND_GROCERY - HOTEL_AND_LODGING - MEDICAL_AND_HEALTH - NON_PROFIT - NOT_SET - ONLINE_GAMBLING - OTC_DRUGS - OTHER - PHYSICAL_GAMBLING - PROFESSIONAL_SERVICES - PUBLIC_SERVICE - RESTAURANT - SHOPPING_AND_RETAIL - TRAVEL_AND_TRANSPORTATION - UNRECOGNIZED description: Category of the sender displayed in the Business Info within WhatsApp. WhatsappSenderChangesDto: type: object properties: status: x-enumDescriptions: APPROVED: The profile field modification has been approved and applied. DEFERRED: The profile field modification has been deferred and will be evaluated later. DELETED: The profile field modification has been removed and is no longer active. EXPIRED: The profile field modification expired prior to completion. PENDING: The profile field modification is currently awaiting review or system processing. REJECTED: The profile field modification has been reviewed and rejected. RESERVED: The requested field parameter value is reserved but has not yet received final approval. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. UNSPECIFIED: The operational status of the field modification is unspecified. description: Current status of the pending changes. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderStatusesEnum' details: anyOf: - $ref: '#/components/schemas/WhatsappSenderDetailsDto' description: For newly created sender - $ref: '#/components/schemas/WhatsappSenderChangesDetailsDto' description: For update sender description: The pending changes to sender details and information uniqueItems: false errorReason: type: string description: Error reason if sender is in state `ERROR`. uniqueItems: false errorCode: x-enumDescriptions: CANNOT_ASSIGN_CREDIT_LINE: Indicates the provisioning system failed to allocate an active financial credit line configuration. CANNOT_ASSIGN_SYSTEM_USER: Indicates the system failed to map an active system user credential reference to the resource context. CANNOT_CREATE_NEW_WHATSAPP_SENDER: Indicates a structural failure occurred during the initialization of the WhatsApp channel. CANNOT_CREATE_WABA_FOR_BUSINESS: Indicates the automated registration workflow failed to instantiate a new WhatsApp Business Account (WABA). CANNOT_GET_DETAILS_FOR_CLOUD_API: Indicates an upstream communication breakdown prevented fetching active Cloud API configuration parameters. CANNOT_GET_WABA_DETAILS: Indicates system query layers failed to retrieve account metadata from the core WhatsApp business registry. CANNOT_REGISTER_NEW_WHATSAPP_SENDER: Indicates the downstream carrier gateway rejected the initial registration request block. CANNOT_REGISTER_TO_CLOUD_API: Indicates the system could not link the communication profile context with Meta Cloud API nodes. CANNOT_SUBSCRIBE_TO_CLOUD_API: Indicates the background event handler failed to bind operational event listeners on the Cloud API cluster. CANNOT_SUBSCRIBE_TO_WEBHOOK: Indicates the streaming broker layer rejected the integration callback subscription sequence. DUPLICATES_ON_SENDER_PHONE_NUMBER: Indicates the provided phone number identifier is already mapped to another active routing terminal. FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES: Indicates an operational query failure prevented compiling the list of certified payload templates. MULTIPLE_WABA_FOR_PROJECT_ID: Indicates a project boundary isolation violation where multiple WABA assets exist for a single project context. NO_CERTIFICATE_AVAILABLE: Indicates the system lacks a valid cryptographic handshake or validation certificate to proceed. NO_NOVA_ACCOUNT_ID: The internal financial node identifier property is missing or null. NO_PRICING_PLAN: The billing rate plan or pricing schema pointer is missing from the request context. NO_PROJECT_ID: The project boundary isolation reference identifier is missing or null. NO_VERIFIED_PHONE_NUMBER: The request payload contains no verified phone number pointers capable of routing. REQUESTED_PHONE_NUMBER_OR_COUNTRY_CODE_CONFLICT: Requested phone number or country code are not the same as assigned in WABA. NOT_VERIFIED_REQUESTED_PHONE_NUMBER: The targeted phone number resource context has not completed verified lifecycle milestones. NOT_VERIFY_BUSINESS_VIA_WHATSAPP: The Meta ecosystem rejected compliance verification for the associated business organization. NOVA_ACCOUNT_ID_CONFLICT: The input financial node identifier conflicts with an existing persistent registration. PROJECT_ID_CONFLICT: The input project boundary reference identifier conflicts with an existing persistent registration. SENDER_HAS_BEEN_DELETED: The designated channel entity footprint has already undergone a permanent cascading deletion sequence. WABA_CONNECTED_TO_ANOTHER_PROJECT: The specified WhatsApp Business Account is actively locked to a separate project isolation layer. UNKNOWN_ERROR: An unclassified internal processing error occurred within the orchestration tier. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Error code if sender is in state `ERROR`. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderErrorCodeEnum' required: - status WhatsappConversationAppRegionsEnum: type: string enum: - br - eu - us description: Conversation API app regions the sender can be used for. WhatsappSenderChangesDetailsDto: type: object properties: displayName: type: string description: Sender display name within WhatsApp. uniqueItems: false description: type: string description: Description of the sender displayed in the Business Info within WhatsApp. uniqueItems: false vertical: x-enumDescriptions: ALCOHOL: The brand operates within the alcohol sector. AUTOMOTIVE: The brand operates within the automotive sector. BEAUTY_SPA_SALON: The brand operates within beauty, spa, or salon services. CLOTHING_AND_APPAREL: The brand operates within clothing and apparel commerce. EDUCATION: The brand operates within the education field. ENTERTAINMENT: The brand operates within the entertainment and media industry. EVENT_PLANNING_AND_SERVICE: The brand operates within event planning and corporate services. FINANCE_AND_BANKING: The brand operates within financial and banking services. FOOD_AND_GROCERY: The brand operates within the food supply or grocery sector. HOTEL_AND_LODGING: The brand operates within hospitality, hotels, or lodging. MEDICAL_AND_HEALTH: The brand operates within healthcare, medical services, or pharmaceuticals. NON_PROFIT: The brand is a registered non-profit organization. NOT_SET: The operational business vertical has not been selected. ONLINE_GAMBLING: The brand operates within the online gambling or betting industry. OTC_DRUGS: The brand operates within over-the-counter drug sales and distribution. OTHER: The brand operates in an industry outside the standard defined taxonomy. PHYSICAL_GAMBLING: The brand operates within physical gambling establishments or casinos. PROFESSIONAL_SERVICES: The brand provides corporate, professional, or technical services. PUBLIC_SERVICE: The brand provides public utilities or governmental services. RESTAURANT: The brand operates a restaurant or food service establishment. SHOPPING_AND_RETAIL: The brand operates within retail or wholesale commerce. TRAVEL_AND_TRANSPORTATION: The brand operates within transportation, travel, or logistics services. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Category of the sender displayed in the Business Info within WhatsApp. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderWhatsAppVerticalEnum' email: type: string description: Contact email displayed in the Business Info within WhatsApp. uniqueItems: false address: type: string description: Business address displayed in the Business Info within WhatsApp. uniqueItems: false websiteOne: type: string description: Business website displayed in the Business Info within WhatsApp. uniqueItems: false websiteTwo: type: string description: Second business website displayed in the Business Info within WhatsApp. uniqueItems: false about: type: string description: "About text displayed in the Business Info within WhatsApp.\n - Hyperlinks can be included but will not render as clickable links.\n - Markdown is not supported.\n " uniqueItems: false photoUrl: type: string description: 'URL to the sender image displayed in WhatsApp. - Supported mime types: `image/jpeg`, `image/png` or `image/webp`. - Maximum file size: 5MB. - Minimum image dimensions: 192 x 192 px. - Maximum image dimensions: 640 x 640 px. - Image will be cropped to maximum image dimensions. - If you submit a PNG image with a transparent background, the background will be rendered as black.' uniqueItems: false username: type: string description: WhatsApp Business username of the sender. uniqueItems: false WhatsappSenderMetaLocalStoragesEnum: type: string enum: - AE - AU - BH - BR - CA - CH - DE - GB - ID - IN - JP - KR - SG - US - ZA - UNRECOGNIZED - UNSPECIFIED description: Region sender store the data in Meta. WhatsappSenderInputNumberProviderTypeEnum: type: string enum: - CUSTOMER - SINCH description: If the phone number is provided by Sinch or the customer. WhatsappSenderBotRegionEnum: type: string enum: - BR - EU - US - UNRECOGNIZED description: Region sender is provisioned in. WhatsappWhatsAppSenderFieldUpdateStatusEnum: type: string enum: - APPROVED - DEFERRED - DELETED - EXPIRED - PENDING - REJECTED - RESERVED - UNRECOGNIZED - UNSPECIFIED description: Current approval status of the field. WhatsappSenderRegisterDto: type: object properties: id: type: string description: The unique ID of the sender. uniqueItems: false method: x-enumDescriptions: SMS: The registration sequence utilizes immediate SMS verification protocols. VOICE: The registration sequence utilizes automated voice-call verification protocols. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Registration Method of the sender. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderRegistrationMethodEnum' accepted: type: string description: The UTC Date Time in ISO 8601 for when the sender was accepted. uniqueItems: false verificationCodeSent: type: boolean description: Whether the verification code has been sent. uniqueItems: false required: - id - method - accepted - verificationCodeSent WhatsappSuggestedUsernamesDto: type: object properties: usernames: description: List of suggested usernames for the sender. uniqueItems: false type: array items: type: string required: - usernames WhatsappSenderInputRegistrationMethodEnum: type: string enum: - SMS - VOICE description: Registration Method of the sender. WhatsappUpdateSenderInputDetailsDto: type: object properties: displayName: type: string minLength: 1 maxLength: 128 description: Sender display name within WhatsApp. uniqueItems: false description: type: - string - 'null' minLength: 1 maxLength: 512 description: Description of the sender displayed in the Business Info within WhatsApp. If null the value will be deleted. uniqueItems: false vertical: x-enumDescriptions: ALCOHOL: Configures the sender profile for a brand operating within the alcohol sector. AUTOMOTIVE: Configures the sender profile for a brand operating within the automotive sector. BEAUTY_SPA_SALON: Configures the sender profile for a brand operating within beauty, spa, or salon services. CLOTHING_AND_APPAREL: Configures the sender profile for a brand operating within clothing and apparel commerce. EDUCATION: Configures the sender profile for a brand operating within the education field. ENTERTAINMENT: Configures the sender profile for a brand operating within the entertainment and media industry. EVENT_PLANNING_AND_SERVICE: Configures the sender profile for a brand operating within event planning and corporate services. FINANCE_AND_BANKING: Configures the sender profile for a brand operating within financial and banking services. FOOD_AND_GROCERY: Configures the sender profile for a brand operating within the food supply or grocery sector. HOTEL_AND_LODGING: Configures the sender profile for a brand operating within hospitality, hotels, or lodging. MEDICAL_AND_HEALTH: Configures the sender profile for a brand operating within healthcare or medical services. NON_PROFIT: Configures the sender profile for a registered non-profit organization. ONLINE_GAMBLING: Configures the sender profile for a brand operating within the online gambling or betting industry. OTC_DRUGS: Configures the sender profile for a brand operating within over-the-counter drug sales and distribution. OTHER: Configures the sender profile for an industry operating outside the standard defined taxonomy. PHYSICAL_GAMBLING: Configures the sender profile for a brand operating within physical gambling establishments or casinos. PROFESSIONAL_SERVICES: Configures the sender profile for a brand providing corporate, professional, or technical services. PUBLIC_SERVICE: Configures the sender profile for a brand providing public utilities or governmental services. RESTAURANT: Configures the sender profile for a brand operating a restaurant or food service establishment. SHOPPING_AND_RETAIL: Configures the sender profile for a brand operating within retail or wholesale commerce. TRAVEL_AND_TRANSPORTATION: Configures the sender profile for a brand operating within transportation, travel, or logistics services. description: Category of the sender displayed in the Business Info within WhatsApp. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputWhatsAppVerticalEnum' email: type: - string - 'null' format: email maxLength: 128 description: Contact email displayed in the Business Info within WhatsApp. If null the value will be deleted. uniqueItems: false address: type: - string - 'null' minLength: 1 maxLength: 256 description: Business address displayed in the Business Info within WhatsApp. If null the value will be deleted. uniqueItems: false websiteOne: type: - string - 'null' format: url maxLength: 256 description: Business website displayed in the Business Info within WhatsApp. If null the value will be deleted. uniqueItems: false websiteTwo: type: - string - 'null' format: url maxLength: 256 description: Second business website displayed in the Business Info within WhatsApp. If null the value will be deleted. uniqueItems: false about: type: - string - 'null' minLength: 1 maxLength: 139 description: "About text displayed in the Business Info within WhatsApp.\n - Hyperlinks can be included but will not render as clickable links.\n - Markdown is not supported.\n If null the value will be deleted." uniqueItems: false photoUrl: type: - string - 'null' format: url maxLength: 256 description: 'URL to the sender image displayed in WhatsApp. - Supported mime types: `image/jpeg`, `image/png` or `image/webp`. - Maximum file size: 5MB. - Minimum image dimensions: 192 x 192 px. - Maximum image dimensions: 640 x 640 px. - Image will be cropped to maximum image dimensions. - If you submit a PNG image with a transparent background, the background will be rendered as black. If null the value will be deleted.' uniqueItems: false username: type: - string - 'null' minLength: 1 description: WhatsApp Business username of the sender. uniqueItems: false WhatsappSenderInputDetailsDto: type: object properties: displayName: type: string minLength: 1 maxLength: 128 description: Sender display name within WhatsApp. uniqueItems: false description: type: string minLength: 1 maxLength: 512 description: Description of the sender displayed in the Business Info within WhatsApp. uniqueItems: false vertical: x-enumDescriptions: ALCOHOL: Configures the sender profile for a brand operating within the alcohol sector. AUTOMOTIVE: Configures the sender profile for a brand operating within the automotive sector. BEAUTY_SPA_SALON: Configures the sender profile for a brand operating within beauty, spa, or salon services. CLOTHING_AND_APPAREL: Configures the sender profile for a brand operating within clothing and apparel commerce. EDUCATION: Configures the sender profile for a brand operating within the education field. ENTERTAINMENT: Configures the sender profile for a brand operating within the entertainment and media industry. EVENT_PLANNING_AND_SERVICE: Configures the sender profile for a brand operating within event planning and corporate services. FINANCE_AND_BANKING: Configures the sender profile for a brand operating within financial and banking services. FOOD_AND_GROCERY: Configures the sender profile for a brand operating within the food supply or grocery sector. HOTEL_AND_LODGING: Configures the sender profile for a brand operating within hospitality, hotels, or lodging. MEDICAL_AND_HEALTH: Configures the sender profile for a brand operating within healthcare or medical services. NON_PROFIT: Configures the sender profile for a registered non-profit organization. ONLINE_GAMBLING: Configures the sender profile for a brand operating within the online gambling or betting industry. OTC_DRUGS: Configures the sender profile for a brand operating within over-the-counter drug sales and distribution. OTHER: Configures the sender profile for an industry operating outside the standard defined taxonomy. PHYSICAL_GAMBLING: Configures the sender profile for a brand operating within physical gambling establishments or casinos. PROFESSIONAL_SERVICES: Configures the sender profile for a brand providing corporate, professional, or technical services. PUBLIC_SERVICE: Configures the sender profile for a brand providing public utilities or governmental services. RESTAURANT: Configures the sender profile for a brand operating a restaurant or food service establishment. SHOPPING_AND_RETAIL: Configures the sender profile for a brand operating within retail or wholesale commerce. TRAVEL_AND_TRANSPORTATION: Configures the sender profile for a brand operating within transportation, travel, or logistics services. description: Category of the sender displayed in the Business Info within WhatsApp. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputWhatsAppVerticalEnum' email: type: string format: email maxLength: 128 description: Contact email displayed in the Business Info within WhatsApp. uniqueItems: false address: type: string minLength: 1 maxLength: 256 description: Business address displayed in the Business Info within WhatsApp. uniqueItems: false websiteOne: type: string format: url maxLength: 256 description: Business website displayed in the Business Info within WhatsApp. uniqueItems: false websiteTwo: type: string format: url maxLength: 256 description: Second business website displayed in the Business Info within WhatsApp. uniqueItems: false about: type: string minLength: 1 maxLength: 139 description: "About text displayed in the Business Info within WhatsApp.\n - Hyperlinks can be included but will not render as clickable links.\n - Markdown is not supported.\n " uniqueItems: false photoUrl: type: string format: url maxLength: 256 description: 'URL to the sender image displayed in WhatsApp. - Supported mime types: `image/jpeg`, `image/png` or `image/webp`. - Maximum file size: 5MB. - Minimum image dimensions: 192 x 192 px. - Maximum image dimensions: 640 x 640 px. - Image will be cropped to maximum image dimensions. - If you submit a PNG image with a transparent background, the background will be rendered as black.' uniqueItems: false required: - displayName - vertical WhatsappSenderInputDtoDeprecated: type: object properties: region: x-enumDescriptions: BR: Specifies that the sender operations should be initialized within the Brazil region. EU: Specifies that the sender operations should be initialized within the Europe region. US: Specifies that the sender operations should be initialized within the United States region. description: Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputRegionEnum' metaLocalStorage: x-enumDescriptions: AE: Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates. AU: Specifies that Meta-managed user and compliance data should be stored within Australia. BH: Specifies that Meta-managed user and compliance data should be stored within Bahrain. BR: Specifies that Meta-managed user and compliance data should be stored within Brazil. CA: Specifies that Meta-managed user and compliance data should be stored within Canada. CH: Specifies that Meta-managed user and compliance data should be stored within Switzerland. DE: Specifies that Meta-managed user and compliance data should be stored within Germany. GB: Specifies that Meta-managed user and compliance data should be stored within the United Kingdom. ID: Specifies that Meta-managed user and compliance data should be stored within Indonesia. IN: Specifies that Meta-managed user and compliance data should be stored within India. JP: Specifies that Meta-managed user and compliance data should be stored within Japan. KR: Specifies that Meta-managed user and compliance data should be stored within South Korea. SG: Specifies that Meta-managed user and compliance data should be stored within Singapore. US: Specifies that Meta-managed user and compliance data should be stored within the United States. ZA: Specifies that Meta-managed user and compliance data should be stored within South Africa. description: Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum' businessManager: x-enumDescriptions: SINCH_BR: Instructs the interface layer to reference public onboarding documentation for the Brazil Meta Business Manager asset. SINCH_MX: Instructs the interface layer to reference public onboarding documentation for the Mexico Meta Business Manager asset. SINCH_UK: Instructs the interface layer to reference public onboarding documentation for the United Kingdom Meta Business Manager asset. description: Business manager. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum' wabaId: type: string description: WhatsApp Business Account that will be connected to the created sender. If left empty, we will try to find the WhatsApp Business Account using your projectId. uniqueItems: false phoneNumberId: type: string description: Phone number ID linked to the WhatsApp Business Account. uniqueItems: false facebookAccessToken: type: string minLength: 1 description: Long-Lived User access token. Mandatory if `facebookCode` is not provided. uniqueItems: false facebookCode: type: string format: uri minLength: 1 description: Single-use access code. Mandatory if `facebookAccessToken` is not provided. uniqueItems: false name: type: string minLength: 1 maxLength: 128 description: Sender name. uniqueItems: false details: description: Sender input details and information. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputDetailsDto' description: SenderInputDto is deprecated. Please use SenderInputEsDto. required: - name - details WhatsappSenderListDto: type: object properties: totalSize: type: number description: Total size of the entries matching the search query. uniqueItems: false pageSize: type: number description: Requested size of the page. uniqueItems: false previousPageToken: type: string description: Encoded token to use in list request to fetch previous batch of entries. uniqueItems: false nextPageToken: type: string description: Encoded token to use in list request to fetch next batch of entries. uniqueItems: false senders: uniqueItems: false type: array items: $ref: '#/components/schemas/WhatsappSenderDto' required: - totalSize - pageSize - senders WhatsappInputSenderPartnerInitiatedDto: type: object properties: status: x-enumDescriptions: DRAFT: Saves the pending changes as a draft without submitting them to the system. SUBMIT: Submits the pending changes directly for processing. description: Create as draft or submit. Defaults to submit. default: SUBMIT uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappActionsEnum' region: x-enumDescriptions: BR: Specifies that the bot execution layer should be provisioned within the Brazil region. EU: Specifies that the bot execution layer should be provisioned within the Europe region. US: Specifies that the bot execution layer should be provisioned within the United States region. description: Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputBotRegionEnum' metaLocalStorage: x-enumDescriptions: AE: Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates. AU: Specifies that Meta-managed user and compliance data should be stored within Australia. BH: Specifies that Meta-managed user and compliance data should be stored within Bahrain. BR: Specifies that Meta-managed user and compliance data should be stored within Brazil. CA: Specifies that Meta-managed user and compliance data should be stored within Canada. CH: Specifies that Meta-managed user and compliance data should be stored within Switzerland. DE: Specifies that Meta-managed user and compliance data should be stored within Germany. GB: Specifies that Meta-managed user and compliance data should be stored within the United Kingdom. ID: Specifies that Meta-managed user and compliance data should be stored within Indonesia. IN: Specifies that Meta-managed user and compliance data should be stored within India. JP: Specifies that Meta-managed user and compliance data should be stored within Japan. KR: Specifies that Meta-managed user and compliance data should be stored within South Korea. SG: Specifies that Meta-managed user and compliance data should be stored within Singapore. US: Specifies that Meta-managed user and compliance data should be stored within the United States. ZA: Specifies that Meta-managed user and compliance data should be stored within South Africa. description: Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum' phoneNumberProvider: x-enumDescriptions: CUSTOMER: Configures the sender to route traffic via a customer-owned and customer-hosted telephony network node. SINCH: Configures the sender to route traffic via an allocated, system-provided network node layer. description: If the phone number is provided by Sinch or the customer. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputNumberProviderTypeEnum' saveDraftOnFailure: type: boolean default: false description: Flag to save sender as draft if submission fails. Defaults to false. uniqueItems: false details: description: Sender input details and information. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappInputSenderPartnerInitiatedDetailsDto' required: - phoneNumberProvider - details WhatsappInputSenderPhoneProvisioningDto: type: object properties: region: x-enumDescriptions: BR: Specifies that the bot execution layer should be provisioned within the Brazil region. EU: Specifies that the bot execution layer should be provisioned within the Europe region. US: Specifies that the bot execution layer should be provisioned within the United States region. description: Region sender is provisioned in. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputBotRegionEnum' metaLocalStorage: x-enumDescriptions: AE: Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates. AU: Specifies that Meta-managed user and compliance data should be stored within Australia. BH: Specifies that Meta-managed user and compliance data should be stored within Bahrain. BR: Specifies that Meta-managed user and compliance data should be stored within Brazil. CA: Specifies that Meta-managed user and compliance data should be stored within Canada. CH: Specifies that Meta-managed user and compliance data should be stored within Switzerland. DE: Specifies that Meta-managed user and compliance data should be stored within Germany. GB: Specifies that Meta-managed user and compliance data should be stored within the United Kingdom. ID: Specifies that Meta-managed user and compliance data should be stored within Indonesia. IN: Specifies that Meta-managed user and compliance data should be stored within India. JP: Specifies that Meta-managed user and compliance data should be stored within Japan. KR: Specifies that Meta-managed user and compliance data should be stored within South Korea. SG: Specifies that Meta-managed user and compliance data should be stored within Singapore. US: Specifies that Meta-managed user and compliance data should be stored within the United States. ZA: Specifies that Meta-managed user and compliance data should be stored within South Africa. description: Region sender store the data in Meta. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum' details: description: Sender input details and information. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappInputSenderPhoneProvisioningDetailsDto' required: - details WhatsappUpdateSenderInputDto: type: object properties: status: x-enumDescriptions: DRAFT: Saves the pending changes as a draft without submitting them to the system. SUBMIT: Submits the pending changes directly for processing. default: DRAFT description: Create as draft or submit. Defaults to draft. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappActionsEnum' details: uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappUpdateSenderInputDetailsDto' WhatsappInputSenderPhoneProvisioningDetailsDto: type: object properties: countryCode: type: string format: country code description: Country code of sender phone number. uniqueItems: false phoneNumber: type: string format: numeric phone number maxLength: 32 description: Sender phone number without country code. uniqueItems: false displayName: type: string minLength: 1 maxLength: 128 description: Sender display name within WhatsApp. uniqueItems: false required: - countryCode - phoneNumber - displayName WhatsappConversationApiAppRegionsEnum: type: string enum: - BR - EU - US - UNRECOGNIZED description: App region. WhatsappConversationAppChannelIntegrationStatusEnum: type: string enum: - ACTIVE - FAILING - PENDING - UNRECOGNIZED description: Status of the channel credentials integration. WhatsappSenderInputVerifyDto: type: object properties: code: type: string format: otp examples: - '123456' description: OTP code used for sender verification. Must be exactly 6 characters with no spaces. Not required if the sender number is already verified by Meta. uniqueItems: false WhatsappSenderInputBotRegionEnum: type: string enum: - BR - EU - US description: Region sender is provisioned in. WhatsappSenderInputWhatsAppVerticalEnum: type: string enum: - ALCOHOL - AUTOMOTIVE - BEAUTY_SPA_SALON - CLOTHING_AND_APPAREL - EDUCATION - ENTERTAINMENT - EVENT_PLANNING_AND_SERVICE - FINANCE_AND_BANKING - FOOD_AND_GROCERY - HOTEL_AND_LODGING - MEDICAL_AND_HEALTH - NON_PROFIT - ONLINE_GAMBLING - OTC_DRUGS - OTHER - PHYSICAL_GAMBLING - PROFESSIONAL_SERVICES - PUBLIC_SERVICE - RESTAURANT - SHOPPING_AND_RETAIL - TRAVEL_AND_TRANSPORTATION description: Category of the sender displayed in the Business Info within WhatsApp. WhatsappSenderStatesEnum: type: string enum: - ACTIVE - IN_PROGRESS - INACTIVE - PENDING_VERIFICATION - SUSPENDED - ERROR description: The current state of the sender. WhatsappActionsEnum: type: string enum: - DRAFT - SUBMIT description: Create as draft or submit. Defaults to draft. WhatsappInputBusinessManagersPublicDocumentationEnum: type: string enum: - SINCH_BR - SINCH_MX - SINCH_UK description: Business manager. WhatsappInputSenderPartnerInitiatedDetailsDto: type: object properties: displayName: type: string minLength: 1 maxLength: 128 description: Sender display name within WhatsApp. uniqueItems: false description: type: string minLength: 1 maxLength: 512 description: Description of the sender displayed in the Business Info within WhatsApp. uniqueItems: false vertical: x-enumDescriptions: ALCOHOL: Configures the sender profile for a brand operating within the alcohol sector. AUTOMOTIVE: Configures the sender profile for a brand operating within the automotive sector. BEAUTY_SPA_SALON: Configures the sender profile for a brand operating within beauty, spa, or salon services. CLOTHING_AND_APPAREL: Configures the sender profile for a brand operating within clothing and apparel commerce. EDUCATION: Configures the sender profile for a brand operating within the education field. ENTERTAINMENT: Configures the sender profile for a brand operating within the entertainment and media industry. EVENT_PLANNING_AND_SERVICE: Configures the sender profile for a brand operating within event planning and corporate services. FINANCE_AND_BANKING: Configures the sender profile for a brand operating within financial and banking services. FOOD_AND_GROCERY: Configures the sender profile for a brand operating within the food supply or grocery sector. HOTEL_AND_LODGING: Configures the sender profile for a brand operating within hospitality, hotels, or lodging. MEDICAL_AND_HEALTH: Configures the sender profile for a brand operating within healthcare or medical services. NON_PROFIT: Configures the sender profile for a registered non-profit organization. ONLINE_GAMBLING: Configures the sender profile for a brand operating within the online gambling or betting industry. OTC_DRUGS: Configures the sender profile for a brand operating within over-the-counter drug sales and distribution. OTHER: Configures the sender profile for an industry operating outside the standard defined taxonomy. PHYSICAL_GAMBLING: Configures the sender profile for a brand operating within physical gambling establishments or casinos. PROFESSIONAL_SERVICES: Configures the sender profile for a brand providing corporate, professional, or technical services. PUBLIC_SERVICE: Configures the sender profile for a brand providing public utilities or governmental services. RESTAURANT: Configures the sender profile for a brand operating a restaurant or food service establishment. SHOPPING_AND_RETAIL: Configures the sender profile for a brand operating within retail or wholesale commerce. TRAVEL_AND_TRANSPORTATION: Configures the sender profile for a brand operating within transportation, travel, or logistics services. description: Category of the sender displayed in the Business Info within WhatsApp. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputWhatsAppVerticalEnum' email: type: string format: email maxLength: 128 description: Contact email displayed in the Business Info within WhatsApp. uniqueItems: false address: type: string minLength: 1 maxLength: 256 description: Business address displayed in the Business Info within WhatsApp. uniqueItems: false websiteOne: type: string format: url maxLength: 256 description: Business website displayed in the Business Info within WhatsApp. uniqueItems: false websiteTwo: type: string format: url maxLength: 256 description: Second business website displayed in the Business Info within WhatsApp. uniqueItems: false about: type: string minLength: 1 maxLength: 139 description: "About text displayed in the Business Info within WhatsApp.\n - Hyperlinks can be included but will not render as clickable links.\n - Markdown is not supported.\n " uniqueItems: false photoUrl: type: string format: url maxLength: 256 description: 'URL to the sender image displayed in WhatsApp. - Supported mime types: `image/jpeg`, `image/png` or `image/webp`. - Maximum file size: 5MB. - Minimum image dimensions: 192 x 192 px. - Maximum image dimensions: 640 x 640 px. - Image will be cropped to maximum image dimensions. - If you submit a PNG image with a transparent background, the background will be rendered as black.' uniqueItems: false countryCode: type: string format: country code description: Numeric country codes (eg. 48 for PL, 44 for UK). uniqueItems: false phoneNumber: type: string format: numeric phone number maxLength: 32 description: 'Numeric phone number without numeric country code eg. 444555666. Cannot exist already such a sender with that phone number. If provided by Sinch.' uniqueItems: false required: - displayName - vertical - countryCode WhatsappDailyLimitEnum: type: string enum: - NOT_SET - TIER_100K - TIER_10K - TIER_1K - TIER_250 - TIER_2K - TIER_50 - TIER_UNLIMITED - UNRECOGNIZED description: 'This property is deprecated. Use `AccountDto.businessDailyLimit` instead. Current daily message limit of the sender. ' WhatsappQualityRatingEnum: type: string enum: - GREEN - RED - YELLOW - UNKNOWN - UNRECOGNIZED description: Current quality rating of the sender. WhatsappPapiErrorDto: type: object properties: errorCode: type: string description: Error code identifying the type of error. uniqueItems: false message: type: string description: Human-readable error message. uniqueItems: false resolution: type: string description: Suggested resolution for the error. uniqueItems: false additionalInformation: type: object additionalProperties: oneOf: - type: array items: type: string description: Additional context about the error. uniqueItems: false required: - errorCode - message - resolution WhatsappSenderNotificationDto: type: object properties: type: x-enumDescriptions: ACTIVE: The notification configuration is active and enabled. COMMENT_ADDED: A new comment has been added to the notification trail. CREATED: The notification configuration has been successfully created. DRAFT: The notification configuration is currently in a draft state. EDITED: The notification configuration has been edited or updated. ERROR: An operational error occurred within the notification flow. IN_PROGRESS: The notification process is currently executing. INACTIVE: The notification configuration is inactive or disabled. REGISTERED: The notification configuration has been registered successfully. REJECTED: The notification configuration has been rejected. VERIFIED: The notification setup has been verified successfully. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderNotificationTypeEnum' created: type: string uniqueItems: false author: type: string uniqueItems: false comment: type: string uniqueItems: false required: - type WhatsappSenderStatusesEnum: type: string enum: - DRAFT - ERROR - IN_PROGRESS - MULTIPLE_WABA_ERROR - REJECTED description: Current status of the pending changes. WhatsappSenderNotificationListDto: type: object properties: totalSize: type: number description: Total size of the entries matching the search query. uniqueItems: false pageSize: type: number description: Requested size of the page. uniqueItems: false previousPageToken: type: string description: Encoded token to use in list request to fetch previous batch of entries. uniqueItems: false nextPageToken: type: string description: Encoded token to use in list request to fetch next batch of entries. uniqueItems: false notifications: type: array items: $ref: '#/components/schemas/WhatsappSenderNotificationDto' uniqueItems: false required: - totalSize - pageSize - notifications WhatsappSenderRegistrationMethodEnum: type: string enum: - SMS - VOICE - UNRECOGNIZED description: Registration Method of the sender. WhatsappSenderErrorCodeEnum: type: string enum: - CANNOT_ASSIGN_CREDIT_LINE - CANNOT_ASSIGN_SYSTEM_USER - CANNOT_CREATE_NEW_WHATSAPP_SENDER - CANNOT_CREATE_WABA_FOR_BUSINESS - CANNOT_GET_DETAILS_FOR_CLOUD_API - CANNOT_GET_WABA_DETAILS - CANNOT_REGISTER_NEW_WHATSAPP_SENDER - CANNOT_REGISTER_TO_CLOUD_API - CANNOT_SUBSCRIBE_TO_CLOUD_API - CANNOT_SUBSCRIBE_TO_WEBHOOK - DUPLICATES_ON_SENDER_PHONE_NUMBER - FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES - MULTIPLE_WABA_FOR_PROJECT_ID - NO_CERTIFICATE_AVAILABLE - NO_NOVA_ACCOUNT_ID - NO_PRICING_PLAN - NO_PROJECT_ID - NO_VERIFIED_PHONE_NUMBER - NOT_VERIFIED_REQUESTED_PHONE_NUMBER - NOT_VERIFY_BUSINESS_VIA_WHATSAPP - NOVA_ACCOUNT_ID_CONFLICT - PROJECT_ID_CONFLICT - REQUESTED_PHONE_NUMBER_OR_COUNTRY_CODE_CONFLICT - SENDER_HAS_BEEN_DELETED - WABA_CONNECTED_TO_ANOTHER_PROJECT - UNKNOWN_ERROR - UNRECOGNIZED description: Error code if sender is in state `ERROR`. WhatsappCommentDto: type: object properties: type: x-enumDescriptions: CREATED: Indicates the comment has been successfully created and published. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappCommentTypeEnum' comment: type: string uniqueItems: false created: type: string uniqueItems: false required: - type - comment WhatsappSenderInputRegisterDto: type: object properties: method: x-enumDescriptions: SMS: The registration sequence utilizes immediate SMS verification protocols. VOICE: The registration sequence utilizes automated voice-call verification protocols. description: Registration Method of the sender. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderInputRegistrationMethodEnum' required: - method WhatsappSenderInputRegionEnum: type: string enum: - BR - EU - US description: Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used. WhatsappSenderDto: type: object properties: id: type: string description: The unique ID of the sender. uniqueItems: false state: x-enumDescriptions: ACTIVE: The sender identity is active and ready to dispatch messages. IN_PROGRESS: The configuration or provisioning sequence for the sender identity is currently in progress. INACTIVE: The sender identity exists within the system but is currently not active. PENDING_VERIFICATION: The sender identity awaits completion of the formal verification and compliance loop. SUSPENDED: The sender identity has been temporarily suspended due to administrative or policy restrictions. ERROR: The sender identity has encountered an operational failure and requires technical troubleshooting. description: The current state of the sender. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderStatesEnum' changes: description: Any pending changes to the sender. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderChangesDto' details: description: Sender details and information. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderDetailsDto' metadata: description: Data about the current state of individual sender fields. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderMetadataDto' region: x-enumDescriptions: BR: Specifies that the bot infrastructure should be hosted within the Brazil region. EU: Specifies that the bot infrastructure should be hosted within the Europe region. US: Specifies that the bot infrastructure should be hosted within the United States region. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Region sender is provisioned in. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderBotRegionEnum' metaLocalStorage: x-enumDescriptions: AE: Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates. AU: Specifies that Meta-managed user and compliance data should be stored within Australia. BH: Specifies that Meta-managed user and compliance data should be stored within Bahrain. BR: Specifies that Meta-managed user and compliance data should be stored within Brazil. CA: Specifies that Meta-managed user and compliance data should be stored within Canada. CH: Specifies that Meta-managed user and compliance data should be stored within Switzerland. DE: Specifies that Meta-managed user and compliance data should be stored within Germany. GB: Specifies that Meta-managed user and compliance data should be stored within the United Kingdom. ID: Specifies that Meta-managed user and compliance data should be stored within Indonesia. IN: Specifies that Meta-managed user and compliance data should be stored within India. JP: Specifies that Meta-managed user and compliance data should be stored within Japan. KR: Specifies that Meta-managed user and compliance data should be stored within South Korea. SG: Specifies that Meta-managed user and compliance data should be stored within Singapore. US: Specifies that Meta-managed user and compliance data should be stored within the United States. ZA: Specifies that Meta-managed user and compliance data should be stored within South Africa. UNSPECIFIED: The Meta data storage residency location is unspecified. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Region sender store the data in Meta. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderMetaLocalStoragesEnum' conversationApiApp: type: string description: If set, the Conversation API App ID the sender is connected to. deprecated: true uniqueItems: false conversationApiAppDetails: description: If set, the details of the Conversation API App the sender is connected to. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappConversationApiAppDto' maxTps: type: number description: Maximum sender TPS. uniqueItems: false qualityRating: x-enumDescriptions: GREEN: Indicates an optimal quality tier with low user block rates and high delivery reliability compliance. RED: Indicates a degraded quality tier with severe block rates, forcing active delivery throttling or profile suspension. YELLOW: Indicates a warning quality tier reflecting increased end-user complaints or delivery metric fluctuations. UNKNOWN: The underlying message quality evaluation history metrics are currently unavailable. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Current quality rating of the sender. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappQualityRatingEnum' dailyLimit: x-enumDescriptions: NOT_SET: The daily messaging threshold tier has not been assigned. TIER_100K: Restricts outbound traffic up to 100,000 business-initiated conversations per rolling 24-hour cycle. TIER_10K: Restricts outbound traffic up to 10,000 business-initiated conversations per rolling 24-hour cycle. TIER_1K: Restricts outbound traffic up to 1,000 business-initiated conversations per rolling 24-hour cycle. TIER_250: Restricts outbound traffic up to 250 business-initiated conversations per rolling 24-hour cycle. TIER_2K: Restricts outbound traffic up to 2,000 business-initiated conversations per rolling 24-hour cycle. TIER_50: Restricts outbound traffic up to 50 business-initiated conversations per rolling 24-hour cycle. TIER_UNLIMITED: No daily throttling thresholds or messaging limit restrictions apply to this profile. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: 'This property is deprecated. Use `AccountDto.businessDailyLimit` instead. Current daily message limit of the sender. ' deprecated: true uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappDailyLimitEnum' bearerToken: type: string description: Bearer token of the sender. The bearer token is needed to connect the sender to a Conversation API App. uniqueItems: false cloudApi: type: boolean description: True if the sender is hosted in WhatsApp Cloud API. deprecated: true uniqueItems: false created: type: string description: The UTC Date Time in ISO 8601 for when the sender was created. uniqueItems: false modified: type: string description: The UTC Date Time in ISO 8601 for when the sender was last modified. uniqueItems: false countryCode: type: string description: Country code of sender phone number. uniqueItems: false phoneNumber: type: string description: Sender phone number without country code. uniqueItems: false numberProvider: x-enumDescriptions: CUSTOMER: The communication channel routes traffic using a customer-owned and customer-hosted network node. SINCH: The communication channel routes traffic using a system-provided and system-provisioned network node. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Provider for phone number. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderNumberProviderTypeEnum' businessManager: x-enumDescriptions: SINCH_AMERICA: Associates the profile configuration with the Sinch America Meta Business Manager account. SINCH_BR: Associates the profile configuration with the Sinch Brazil Meta Business Manager account. SINCH_MX: Associates the profile configuration with the Sinch Mexico Meta Business Manager account. SINCH_SEP: Associates the profile configuration with the Sinch SEP Meta Business Manager account. SINCH_UK: Associates the profile configuration with the Sinch UK Meta Business Manager account. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Business manager. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappBusinessManagersEnum' wabaBanState: x-enumDescriptions: DISABLE: The WhatsApp Business Account has been disabled due to administrative or policy enforcement. REINSTATE: The WhatsApp Business Account has been successfully reinstated and cleared of restrictions. SCHEDULE_FOR_DISABLE: The WhatsApp Business Account is scheduled for automatic disablement following a grace or appeal period. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Please use get account endpoint for this information. deprecated: true uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappWabaBanStatesEnum' wabaBanDate: type: string description: Please use get account endpoint for this information. deprecated: true uniqueItems: false compatibleRegions: type: array x-enumDescriptions: br: The messaging applications and session contexts are hosted within the Brazil region. eu: The messaging applications and session contexts are hosted within the Europe region. us: The messaging applications and session contexts are hosted within the United States region. uniqueItems: true description: Conversation API app regions the sender can be used for. items: $ref: '#/components/schemas/WhatsappConversationAppRegionsEnum' required: - id - region - metaLocalStorage - cloudApi - businessManager - compatibleRegions WhatsappSenderNumberProviderTypeEnum: type: string enum: - CUSTOMER - SINCH - UNRECOGNIZED description: Provider for phone number. WhatsappBusinessManagersEnum: type: string enum: - SINCH_AMERICA - SINCH_BR - SINCH_MX - SINCH_SEP - SINCH_UK - UNRECOGNIZED description: Business manager. WhatsappSenderDetailsDto: type: object properties: displayName: type: string description: Sender display name within WhatsApp. uniqueItems: false description: type: string description: Description of the sender displayed in the Business Info within WhatsApp. uniqueItems: false vertical: x-enumDescriptions: ALCOHOL: The brand operates within the alcohol sector. AUTOMOTIVE: The brand operates within the automotive sector. BEAUTY_SPA_SALON: The brand operates within beauty, spa, or salon services. CLOTHING_AND_APPAREL: The brand operates within clothing and apparel commerce. EDUCATION: The brand operates within the education field. ENTERTAINMENT: The brand operates within the entertainment and media industry. EVENT_PLANNING_AND_SERVICE: The brand operates within event planning and corporate services. FINANCE_AND_BANKING: The brand operates within financial and banking services. FOOD_AND_GROCERY: The brand operates within the food supply or grocery sector. HOTEL_AND_LODGING: The brand operates within hospitality, hotels, or lodging. MEDICAL_AND_HEALTH: The brand operates within healthcare, medical services, or pharmaceuticals. NON_PROFIT: The brand is a registered non-profit organization. NOT_SET: The operational business vertical has not been selected. ONLINE_GAMBLING: The brand operates within the online gambling or betting industry. OTC_DRUGS: The brand operates within over-the-counter drug sales and distribution. OTHER: The brand operates in an industry outside the standard defined taxonomy. PHYSICAL_GAMBLING: The brand operates within physical gambling establishments or casinos. PROFESSIONAL_SERVICES: The brand provides corporate, professional, or technical services. PUBLIC_SERVICE: The brand provides public utilities or governmental services. RESTAURANT: The brand operates a restaurant or food service establishment. SHOPPING_AND_RETAIL: The brand operates within retail or wholesale commerce. TRAVEL_AND_TRANSPORTATION: The brand operates within transportation, travel, or logistics services. UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version. description: Category of the sender displayed in the Business Info within WhatsApp. uniqueItems: false allOf: - $ref: '#/components/schemas/WhatsappSenderWhatsAppVerticalEnum' email: type: string description: Contact email displayed in the Business Info within WhatsApp. uniqueItems: false address: type: string description: Business address displayed in the Business Info within WhatsApp. uniqueItems: false websiteOne: type: string description: Business website displayed in the Business Info within WhatsApp. uniqueItems: false websiteTwo: type: string description: Second business website displayed in the Business Info within WhatsApp. uniqueItems: false about: type: string description: "About text displayed in the Business Info within WhatsApp.\n - Hyperlinks can be included but will not render as clickable links.\n - Markdown is not supported.\n " uniqueItems: false photoUrl: type: string description: 'URL to the sender image displayed in WhatsApp. - Supported mime types: `image/jpeg`, `image/png` or `image/webp`. - Maximum file size: 5MB. - Minimum image dimensions: 192 x 192 px. - Maximum image dimensions: 640 x 640 px. - Image will be cropped to maximum image dimensions. - If you submit a PNG image with a transparent background, the background will be rendered as black.' uniqueItems: false username: type: string description: WhatsApp Business username of the sender. uniqueItems: false required: - displayName - vertical WhatsappWabaBanStatesEnum: type: string enum: - DISABLE - REINSTATE - SCHEDULE_FOR_DISABLE - UNRECOGNIZED description: Please use get account endpoint for this information. securitySchemes: BasicAuth: type: http scheme: basic BearerAuth: type: http scheme: bearer bearerFormat: JWT OAuth2Production: type: oauth2 description: OAuth2 authorization for production flows: clientCredentials: tokenUrl: https://auth.sinch.com/oauth2/token scopes: '-': '-' x-tagGroup-upscale: name: Upscale tags: - Upscale Admin Feature Flag - Upscale Admin Log Operation - Upscale Admin Migrations - Upscale Admin Sms - Upscale Admin Upscales - Internal - Upscale Sms - Upscale Upscales x-tagGroup-notification: name: Notification tags: - Notification Admin Feature Flag - Notification Admin Log Operation - Internal x-tagGroups: - name: Webhook tags: - Webhooks - name: WhatsApp tags: - WhatsApp Accounts - WhatsApp - WhatsApp Flows - WhatsApp Senders - WhatsApp Solutions - WhatsApp Templates - name: Bundles tags: - Bundles - name: KakaoTalk tags: - KakaoTalk Categories - KakaoTalk Senders - KakaoTalk Templates - name: Conversation tags: - Conversation - name: RCS tags: - RCS Accounts - RCS Questionnaire - RCS Senders - name: SMS tags: - SMS Apps