WhatsApp Accounts

The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments.

Get account for project GA 

Returns an account for a project.
SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

Responses
200

Account

Response Schema: application/json
isEmbeddedSignup
required
boolean

true if the Account was created through Embedded Signup. false otherwise.

businessManager
required
string

Business manager.

Enum: "SINCH_AMERICA" "SINCH_BR" "SINCH_MX" "SINCH_SEP" "SINCH_UK" "UNRECOGNIZED"
compatibleRegions
required
Array of strings (WhatsappRegions) unique

Conversation API app regions the sender can be used for.

Items Enum: "br" "eu" "us"
state
string

The current state of your account.

Enum: "ONBOARDED" "PENDING_FACEBOOK_VERIFICATION" "REJECTED"
wabaId
string

WhatsApp Business Manager ID.

object

Any pending changes to the account.

object

Account details and information.

wabaBanState
string

Ban state when account has been banned.

Enum: "DISABLE" "REINSTATE" "SCHEDULE_FOR_DISABLE" "UNRECOGNIZED"
wabaBanDate
string

The UTC Date Time in ISO 8601 for when account has been banned.

wabaEnabledForInsights
boolean

Template analytics status for account.

primaryBusinessLocation
string

Two-letter country code in ISO 3166 standard, specifying the country where business is based

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BW" "BY" "BZ" "CA" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "UNRECOGNIZED"
401

Unauthorized

404

NotFound

409

Conflict

500

InternalServerError

get/v1/projects/{projectId}/whatsapp
Request samples 
Response samples 
application/json
Response with an account.



{
  • "state": "ONBOARDED",
  • "isEmbeddedSignup": false,
  • "businessManager": "SINCH_UK",
  • "wabaId": "1234567890",
  • "details": {
    • "companyLegalName": "Legal name of company",
    • "clientBusinessManagerId": "1234567890"
    },
  • "wabaEnabledForInsights": false,
  • "compatibleRegions": [
    • "eu",
    • "us"
    ]
}
Create account for project GA 
Create the WhatsApp account for the project. Each project can only have one account.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
Request Body schema: application/json
required
Account data


companyLegalName
required
string  [ 1 .. 255 ] characters 
The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id= Ensure that the name shown exactly matches the one you enter here.


 
clientBusinessManagerId
required
string  [ 1 .. 255 ] characters 
The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name.


 
businessManager
string
Business manager.


 Enum: "SINCH_AMERICA" "SINCH_BR" "SINCH_MX" "SINCH_SEP" "SINCH_UK"  
Responses 
201
Account


Response Schema: application/json
isEmbeddedSignup
required
boolean
true if the Account was created through Embedded Signup. false otherwise.


 
businessManager
required
string
Business manager.


 Enum: "SINCH_AMERICA" "SINCH_BR" "SINCH_MX" "SINCH_SEP" "SINCH_UK" "UNRECOGNIZED"  
compatibleRegions
required
Array of strings (WhatsappRegions)   unique 
Conversation API app regions the sender can be used for.


Items Enum: "br" "eu" "us"  
state
string
The current state of your account.


 Enum: "ONBOARDED" "PENDING_FACEBOOK_VERIFICATION" "REJECTED"  
wabaId
string
WhatsApp Business Manager ID.


 
object
Any pending changes to the account.


 
object
Account details and information.


 
wabaBanState
string
Ban state when account has been banned.


 Enum: "DISABLE" "REINSTATE" "SCHEDULE_FOR_DISABLE" "UNRECOGNIZED"  
wabaBanDate
string
The UTC Date Time in ISO 8601 for when account has been banned.


 
wabaEnabledForInsights
boolean
Template analytics status for account.


 
primaryBusinessLocation
string
Two-letter country code in ISO 3166 standard, specifying the country where business is based


 Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BW" "BY" "BZ" "CA" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "UNRECOGNIZED"  
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


Callbacks 
postComment on account
postAccount onboarded
postAccount rejected
postAccount pending verification
postAccount business information changed
post/v1/projects/{projectId}/whatsapp
Request samples 
application/json
Example body request to create an account.
  



{
  • "companyLegalName": "Legal name of company",
  • "clientBusinessManagerId": "1234567890"
}
Response samples 
application/json
Response when successfully creating an account.



{
  • "isEmbeddedSignup": false,
  • "businessManager": "SINCH_UK",
  • "wabaId": "1234567890",
  • "changes": {
    • "status": "IN_PROGRESS",
    • "details": {
      }
    },
  • "compatibleRegions": [
    • "eu",
    • "us"
    ]
}
Callback payload samples 
application/json
{
  • "type": "WHATSAPP_ACCOUNT_COMMENT_ADDED",
  • "payload": {
    • "state": "ONBOARDED",
    • "isEmbeddedSignup": false,
    • "businessManager": "SINCH_UK",
    • "wabaId": "1234567890",
    • "details": {
      },
    • "wabaEnabledForInsights": false,
    • "compatibleRegions": [
      ]
    },
  • "comment": "Example comment"
}
Update account for project GA 
Update an account. 

It is only possible to update an account that has been rejected. After update the status will be set to `IN_PROGRESS`.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
Request Body schema: application/json
required
Supported account fields to update.


companyLegalName
string  [ 1 .. 255 ] characters 
The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id= Ensure that the name shown exactly matches the one you enter here.


 
clientBusinessManagerId
string  [ 1 .. 255 ] characters 
The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name.


 
Responses 
200
Account


Response Schema: application/json
isEmbeddedSignup
required
boolean
true if the Account was created through Embedded Signup. false otherwise.


 
businessManager
required
string
Business manager.


 Enum: "SINCH_AMERICA" "SINCH_BR" "SINCH_MX" "SINCH_SEP" "SINCH_UK" "UNRECOGNIZED"  
compatibleRegions
required
Array of strings (WhatsappRegions)   unique 
Conversation API app regions the sender can be used for.


Items Enum: "br" "eu" "us"  
state
string
The current state of your account.


 Enum: "ONBOARDED" "PENDING_FACEBOOK_VERIFICATION" "REJECTED"  
wabaId
string
WhatsApp Business Manager ID.


 
object
Any pending changes to the account.


 
object
Account details and information.


 
wabaBanState
string
Ban state when account has been banned.


 Enum: "DISABLE" "REINSTATE" "SCHEDULE_FOR_DISABLE" "UNRECOGNIZED"  
wabaBanDate
string
The UTC Date Time in ISO 8601 for when account has been banned.


 
wabaEnabledForInsights
boolean
Template analytics status for account.


 
primaryBusinessLocation
string
Two-letter country code in ISO 3166 standard, specifying the country where business is based


 Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BW" "BY" "BZ" "CA" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "UNRECOGNIZED"  
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


patch/v1/projects/{projectId}/whatsapp
Request samples 
application/json
  Example body request to update an account.
  



{
  • "companyLegalName": "Update legal name of company",
  • "clientBusinessManagerId": "1234567890"
}
Response samples 
application/json
Response when successfully update an account.



{
  • "state": "REJECTED",
  • "isEmbeddedSignup": false,
  • "businessManager": "SINCH_UK",
  • "wabaId": "1234567890",
  • "changes": {
    • "status": "IN_PROGRESS",
    • "details": {
      }
    },
  • "details": {
    • "companyLegalName": "Legal name of company",
    • "clientBusinessManagerId": "1234567890"
    },
  • "wabaEnabledForInsights": true,
  • "compatibleRegions": [
    • "eu",
    • "us"
    ]
}
Lists activities on account GA 
Lists activities on account from the most recent one to the oldest one.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
query Parameters
pageToken
string
The page token if retrieving the next page from a previous query.


 
pageSize
number  [ 1 .. 100 ] 
The page size requested.


 
Responses 
200
Recent activities on account


Response Schema: application/json
totalSize
required
number
Total size of the entries matching the search query.


 
pageSize
required
number
Requested size of the page.


 
required
Array of objects (WhatsappAccountNotificationDto) 
 
previousPageToken
string
Encoded token to use in list request to fetch previous batch of entries.


 
nextPageToken
string
Encoded token to use in list request to fetch next batch of entries.


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/whatsapp/activities
Request samples 
Response samples 
application/json
Response for all account activities.



{
  • "totalSize": 2,
  • "pageSize": 50,
  • "notifications": [
    • {
      },
    • {
      }
    ]
}
Creates a comment for an account GA 
Creates a comment for an account.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
Request Body schema: application/json
required
Comment data


comment
required
string  [ 1 .. 65535 ] characters 
 
Responses 
201
Created comment for an account.


Response Schema: application/json
type
required
string
 Value: "CREATED"  
comment
required
string
 
created
string
 
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


post/v1/projects/{projectId}/whatsapp/comments
Request samples 
application/json
  Example body request to create a comment.
  



{
  • "comment": "Example comment."
}
Response samples 
application/json
Response when successfully creating a comment.



{
  • "type": "CREATED",
  • "comment": "Example comment",
  • "created": "2023-01-19T13:11:08.204Z"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.