Sign in
latestOpenAPI 3.1.02026-08-18893023.3 MB

c78a716de420

WhatsApp Senders

Create sender for project

Creates a sender for a project. The possible combinations of region, business manager and hosting type are the following

RegionSINCH_BRSINCH_MXSINCH_UK
BREmbedded (ES)✅ Supported✅ Supported❌ Unsupported
Partner-initiated✅ Supported✅ Supported❌ Unsupported
EUEmbedded (ES)❌ Unsupported❌ Unsupported✅ Supported
Partner-initiated❌ Unsupported❌ Unsupported✅ Supported
USEmbedded (ES)✅ Supported✅ Supported✅ Supported
Partner-initiated✅ Supported✅ Supported✅ Supported
post/v1/projects/{projectId}/whatsapp/senders

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

Request body

OR
OR
OR

Response

Sender

idstring required

The unique ID of the sender.

state'ACTIVE' | 'IN_PROGRESS' | 'INACTIVE' | 'PENDING_VERIFICATION' | 'SUSPENDED' | 'ERROR'

The current state of the sender.

region'BR' | 'EU' | 'US' | 'UNRECOGNIZED' required

Region sender is provisioned in.

metaLocalStorage'AE' | 'AU' | 'BH' | 'BR' | 'CA' | 'CH' | 'DE' | 'GB' | 'ID' | 'IN' | 'JP' | 'KR' | 'SG' | 'US' | 'ZA' | 'UNRECOGNIZED' | 'UNSPECIFIED' required

Region sender store the data in Meta.

conversationApiAppstring

If set, the Conversation API App ID the sender is connected to.

maxTpsnumber

Maximum sender TPS.

qualityRating'GREEN' | 'RED' | 'YELLOW' | 'UNKNOWN' | 'UNRECOGNIZED'

Current quality rating of the sender.

dailyLimit'NOT_SET' | 'TIER_100K' | 'TIER_10K' | 'TIER_1K' | 'TIER_250' | 'TIER_2K' | 'TIER_50' | 'TIER_UNLIMITED' | 'UNRECOGNIZED'

This property is deprecated. Use AccountDto.businessDailyLimit instead. Current daily message limit of the sender.

bearerTokenstring

Bearer token of the sender. The bearer token is needed to connect the sender to a Conversation API App.

cloudApiboolean required

True if the sender is hosted in WhatsApp Cloud API.

createdstring

The UTC Date Time in ISO 8601 for when the sender was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the sender was last modified.

countryCodestring

Country code of sender phone number.

phoneNumberstring

Sender phone number without country code.

numberProvider'CUSTOMER' | 'SINCH' | 'UNRECOGNIZED'

Provider for phone number.

businessManager'SINCH_AMERICA' | 'SINCH_BR' | 'SINCH_MX' | 'SINCH_SEP' | 'SINCH_UK' | 'UNRECOGNIZED' required

Business manager.

wabaBanState'DISABLE' | 'REINSTATE' | 'SCHEDULE_FOR_DISABLE' | 'UNRECOGNIZED'

Please use get account endpoint for this information.

wabaBanDatestring

Please use get account endpoint for this information.

compatibleRegionsstring[] required

Conversation API app regions the sender can be used for.