Create a new profile

Deprecated

Deprecated. This endpoint is replaced by /v3/sender-profiles and will be removed in a future release. It still behaves exactly as before, so nothing needs to change today — but new integrations should use /v3/sender-profiles, which models a profile's markets, compliance, brand, campaigns and billing explicitly.

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 owns its own WhatsApp Business Account — accounts are never shared between profiles or inherited from the organization. Provide a whatsapp_business_account object with waba_id, phone_number_id, and access_token. Obtain these from Meta Business Manager by creating a System User with whatsapp_business_messaging and whatsapp_business_management permissions.

Omit the field and the profile is created without WhatsApp, staying incomplete until it has an account of its own.

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.

POST
/v3/profiles

Header Parameters

Idempotency-Key?string

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.

Match^[a-zA-Z0-9_-]+$
Lengthlength <= 255
x-profile-id?string

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.

Formatuuid

Request Body

application/json
  1. body

Request to create a new profile

sandbox?boolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

name*string

Profile name (required)

Length0 <= length <= 100
icon?|

Profile icon URL (optional)

description?|

Profile description (optional)

short_name?|

Profile short name/abbreviation (optional). Must be 3–11 characters, contain only letters, numbers, and spaces, and include at least one letter. Example: "SALES", "Mkt 2", "Support1".

inherit_tcr_brand?|

Whether this profile inherits TCR brand from organization (default: false)

inherit_tcr_campaign?|

Whether this profile inherits TCR campaign from organization (default: false)

billing_model?|

Billing model: profile, organization, or profile_and_organization (default: profile).

  • "organization": the organization's billing details are used; no profile-level billing info needed.
  • "profile": the profile is billed independently; billing_contact is required.
  • "profile_and_organization": the profile is billed first with the organization as fallback; billing_contact is required.
billing_contact?|null

Billing contact for this profile. Required when billing_model is "profile" or "profile_and_organization". Identifies who receives invoices and who is responsible for payment.

whatsapp_business_account?|null

Direct WhatsApp Business Account credentials for this profile. When provided, the profile uses its own WhatsApp Business Account instead of inheriting from the organization. When omitted, the profile inherits the organization's WhatsApp Business Account (requires the organization to have completed WhatsApp Embedded Signup).

brand?|null

Brand and KYC information for this profile (optional). When provided, creates the brand associated with this profile. Cannot be set when inherit_tcr_brand is true.

payment_details?|null

Payment card details for this profile (optional). Accepted when billing_model is "profile" or "profile_and_organization". Not persisted on our servers — forwarded to the payment processor.

allow_contact_sharing?|Deprecated

Deprecated. Accepted and ignored. Contact and template sharing between sender profiles is gone — a profile sees only what it owns, and the organization still sees all of its profiles' contacts and templates through read-time widening. The four columns behind these flags were dropped by M260720120000.

Bound rather than dropped so the properties survive on the wire and in a generated client: an SDK that assigns them keeps compiling, which is the compatibility this exists for. Deliberately not refused either — a 400 would break an integration that is otherwise working, and the capability they ask for is gone either way. Same rule as SendingPhoneNumberProfileId.

The read is what makes this survivable: every profile reports all four as false, so a caller that checks its own write can see it did not take. Requests carrying one are logged, so we can tell when nobody sends them any more and the fields can go for real.

allow_template_sharing?boolean|nullDeprecated
inherit_contacts?boolean|nullDeprecated
inherit_templates?boolean|nullDeprecated

Response Body

Profile created successfully

application/json
  1. response

Standard API response envelope for all v3 endpoints

success?boolean

Indicates whether the request was successful

data?|null

The response data (null if error)

error?|null

Error details (null if successful)

meta?

Metadata about the request and response

Example Request
curl -X POST 'https://api.sent.dm/v3/profiles' \  -H 'Idempotency-Key: req_abc123_retry1' \  -H 'Content-Type: application/json' \  -d '{  "name": "Sales Team",  "icon": "https://example.com/sales-icon.png",  "description": "Sales department sender profile",  "short_name": "SALES",  "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",      "isTcrApplication": true,      "phoneNumberPrefix": "+1",      "destinationCountries": [        {          "id": "US",          "isMain": false        }      ]    }  },  "payment_details": {    "card_number": "4111111111111111",    "expiry": "09/27",    "cvc": "123",    "zip_code": "10001"  },  "sandbox": false}'
Example Response
{  "success": true,  "data": {    "id": "770e8400-e29b-41d4-a716-446655440002",    "organization_id": "550e8400-e29b-41d4-a716-446655440000",    "name": "Sales Team",    "email": "team@acme.com",    "icon": "https://example.com/sales-icon.png",    "description": "Sales department sender profile",    "short_name": "SALES",    "status": "incomplete",    "created_at": "2026-11-12T15:32:26.7001996+00:00",    "updated_at": "2026-11-12T15:32:26.700208+00:00",    "allow_contact_sharing": false,    "allow_template_sharing": false,    "inherit_contacts": false,    "inherit_templates": false,    "inherit_tcr_brand": false,    "inherit_tcr_campaign": false,    "billing_model": "profile",    "sending_phone_number_profile_id": null,    "sending_whatsapp_number_profile_id": null,    "sending_phone_number": null,    "whatsapp_phone_number": null,    "allow_number_change_during_onboarding": null,    "waba_id": "123456789012345",    "billing_contact": {      "name": "Acme Corp",      "email": "billing@acmecorp.com",      "phone": "+12025551234",      "address": "123 Main Street, New York, NY 10001, US"    },    "brand": {      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "tcr_brand_id": null,      "status": null,      "identity_status": null,      "universal_ein": null,      "csp_id": null,      "submitted_to_tcr": false,      "submitted_at": null,      "is_inherited": false,      "created_at": "2026-11-12T15:32:26.7003216+00:00",      "updated_at": null,      "contact": {        "name": "John Smith",        "business_name": "Acme Corp",        "role": null,        "phone": null,        "email": "john@acmecorp.com",        "phone_country_code": null      },      "business": {        "legal_name": "Acme Corporation LLC",        "tax_id": null,        "tax_id_type": null,        "entity_type": null,        "street": null,        "city": null,        "state": null,        "postal_code": null,        "country": "US",        "url": null,        "country_of_registration": null      },      "compliance": {        "vertical": "PROFESSIONAL",        "brand_relationship": "SMALL_ACCOUNT",        "is_tcr_application": true,        "phone_number_prefix": null,        "destination_countries": [          {            "id": "US",            "isMain": false          }        ],        "notes": null,        "primary_use_case": null      }    }  },  "error": null,  "meta": {    "request_id": "req_7X9zKp2jDw",    "timestamp": "2026-11-12T15:32:26.7005205+00:00",    "version": "v3"  }}

Get profile by ID GET

**Deprecated.** This endpoint is replaced by `/v3/sender-profiles` and will be removed in a future release. It still behaves exactly as before, so nothing needs to change today — but new integrations should use `/v3/sender-profiles`, which models a profile's markets, compliance, brand, campaigns and billing explicitly. Retrieves detailed information about a specific sender profile within an organization, including brand and KYC information if a brand has been configured.

Update profile settings PATCH

**Deprecated.** This endpoint is replaced by `/v3/sender-profiles` and will be removed in a future release. It still behaves exactly as before, so nothing needs to change today — but new integrations should use `/v3/sender-profiles`, which models a profile's markets, compliance, brand, campaigns and billing explicitly. Updates a profile's configuration and settings. Requires admin role in the organization. Only provided fields will be updated (partial update). ## Brand Management Include the optional `brand` field to create or update the brand associated with this profile. The brand holds KYC and TCR compliance data (legal business info, contact details, messaging vertical). Once a brand has been submitted to TCR it cannot be modified. Setting `inherit_tcr_brand: true` and providing `brand` in the same request is not allowed. ## 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. ## Deprecated fields `sending_phone_number_profile_id` and `sending_whatsapp_number_profile_id` are **accepted and ignored**. Sender borrowing is gone: a profile cannot send from another profile's number, because two profiles behind one sender makes an inbound reply and a delivery receipt ambiguous about whose they are. Sending either **changes nothing and still returns `200`** — they are kept on the contract so an existing integration keeps working. Reads carry both keys too and always answer `null`, which is how you can confirm the value did not take. Give the profile a sender of its own instead — `POST /v3/channels/sms` or `POST /v3/channels/whatsapp`, sent with the `x-profile-id` header naming it.