Skip to main content
POST
Create or update a sender

Authorizations

Authorization
string
header
required

HTTP Basic where username is your account e-mail and password is your security token.

Body

application/json
name
string
required
display_phone
string
required
phone_number_id
string
required
per_hour_limit
integer
required
id
integer

Provide to update; omit/0 to create.

waba_id
string

Required when creating.

access_token
string

Required when creating without OAuth. On update, the stored token is kept if omitted. Stored encrypted.

api_version
string
default:v21.0
status
enum<string>
default:active
Available options:
active,
paused,
disabled
use_oauth
enum<integer>

Setting 0 clears any stored OAuth configuration.

Available options:
0,
1
oauth_url
string

Required when use_oauth=1.

oauth_client_id
string

Required when use_oauth=1.

oauth_client_secret
string

Required when creating with use_oauth=1; preserved if omitted on update. Stored encrypted.

oauth_scope
string
oauth_grant_type
string
default:client_credentials

Response

Saved

Standard envelope used by the WhatsApp message and sender endpoints (same shape as the letters and e-mail envelopes).

status
integer
Example:

200

status_message
string
data
object