Create a new profile
Creates a new sender profile within an organization. Profiles represent different brands, departments, or use cases, each with their own messaging configuration and settings. Requires admin role in the organization.
WhatsApp Business Account
Every profile must be linked to a WhatsApp Business Account. There are two ways to do this:
1. Inherit from organization (default) — Omit the whatsapp_business_account field. The profile will share the organization's WhatsApp Business Account, which must have been set up via WhatsApp Embedded Signup. This is the recommended path for most use cases.
2. Direct credentials — Provide a whatsapp_business_account object with waba_id, phone_number_id, and access_token. Use this when the profile needs its own independent WhatsApp Business Account. Obtain these from Meta Business Manager by creating a System User with whatsapp_business_messaging and whatsapp_business_management permissions.
If the whatsapp_business_account field is omitted and the organization has no WhatsApp Business Account configured, the request will be rejected with HTTP 422.
Brand
Include the optional brand field to create the brand for this profile at the same time. Cannot be used when inherit_tcr_brand is true.
Payment Details
When billing_model is "profile" or "profile_and_organization" you may include a payment_details object containing the card number, expiry (MM/YY), CVC, and billing ZIP code. Payment details are never stored on our servers and are forwarded directly to the payment processor. Providing payment_details when billing_model is "organization" is not allowed.
Headers
Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.
Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.
Request body
Example request
{
"name": "Sales Team",
"icon": "https://example.com/sales-icon.png",
"description": "Sales department sender profile",
"short_name": "SALES",
"allow_contact_sharing": true,
"allow_template_sharing": false,
"inherit_contacts": true,
"inherit_templates": true,
"inherit_tcr_brand": false,
"inherit_tcr_campaign": false,
"billing_model": "profile",
"billing_contact": {
"name": "Acme Corp",
"email": "billing@acmecorp.com",
"phone": "+12025551234",
"address": "123 Main Street, New York, NY 10001, US"
},
"whatsapp_business_account": {
"waba_id": "123456789012345",
"phone_number_id": "987654321098765",
"access_token": "EAAxxxxxxxxxxxxxxx"
},
"brand": {
"contact": {
"name": "John Smith",
"businessName": "Acme Corp",
"role": "CEO",
"phone": "+12025551234",
"email": "john@acmecorp.com",
"phoneCountryCode": "1"
},
"business": {
"legalName": "Acme Corporation LLC",
"taxId": "12-3456789",
"taxIdType": "us_ein",
"entityType": "PRIVATE_PROFIT",
"street": "123 Main Street",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"url": "https://acmecorp.com",
"countryOfRegistration": "US"
},
"compliance": {
"vertical": "PROFESSIONAL",
"brandRelationship": "SMALL_ACCOUNT",
"primaryUseCase": "Customer notifications and appointment reminders",
"expectedMessagingVolume": "10000",
"isTcrApplication": true,
"phoneNumberPrefix": "+1",
"destinationCountries": [
{
"id": "US",
"isMain": false
}
],
"notes": null
}
},
"payment_details": {
"card_number": "4111111111111111",
"expiry": "09/27",
"cvc": "123",
"zip_code": "10001"
},
"sandbox": false
}Response
Profile created successfully