Update profile settings

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sandbox?boolean

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

name?|

Profile name (optional)

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 (optional)

inherit_tcr_campaign?|

Whether this profile inherits TCR campaign from organization (optional)

billing_model?|

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

"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" and no billing contact has been configured yet. Identifies who receives invoices and who is responsible for payment.

sending_phone_number_profile_id?|Deprecated

Deprecated. Accepted and ignored. Sender borrowing is gone: a profile cannot send from another profile's SMS number. Supplying this changes nothing and the request still succeeds.

Bound rather than dropped so the property survives on the wire and in a generated client — an SDK that assigns it keeps compiling, which is the compatibility this exists for. It is deliberately not refused: a 400 here would break an integration that is otherwise working, and the capability it asks for is gone either way.

The trade-off, stated plainly. A caller asking for borrowing is told it succeeded when nothing happened. What makes that survivable is the read: sending_phone_number_profile_id comes back null on every profile, so a caller that checks its own write can see it did not take. Every request that carries one is logged, so we can tell when nobody is sending it any more and the field can go for real.

Give the profile a sender of its own instead: POST /v3/channels/sms with the x-profile-id header naming it.

Formatuuid

sending_whatsapp_number_profile_id?|Deprecated

Formatuuid

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.

Retired the same way as SendingPhoneNumberProfileId, and for the same reason: the properties stay bound so an SDK that assigns them keeps compiling, and a 400 would break a working integration over a capability that is gone regardless. Every profile reports all four as false, so a caller that checks its own write can see it did not take.

allow_template_sharing?boolean|nullDeprecated

inherit_contacts?boolean|nullDeprecated

inherit_templates?boolean|nullDeprecated

sending_phone_number?|

Direct phone number for SMS sending (optional)

whatsapp_phone_number?|

Direct phone number for WhatsApp sending (optional)

allow_number_change_during_onboarding?|

Whether number changes are allowed during onboarding (optional)

brand?|null

Brand and KYC information for this profile (optional). When provided, creates or updates the brand associated with this profile. Cannot be set when inherit_tcr_brand is true. Once a brand has been submitted to TCR it cannot be modified.

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.

Response Body

`application/json`

curl -X PATCH "https://example.com/v3/profiles/770e8400-e29b-41d4-a716-446655440002" \  -H "Idempotency-Key: req_abc123_retry1" \  -H "Content-Type: application/json" \  -d '{    "name": "Sales Team - Updated",    "description": "Updated sales department sender profile",    "short_name": "SALES",    "billing_model": "organization",    "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          }        ]      }    },    "sandbox": false  }'

{
  "success": true,
  "data": {
    "id": "770e8400-e29b-41d4-a716-446655440002",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Sales Team - Updated",
    "email": "team@acme.com",
    "icon": "https://example.com/sales-icon.png",
    "description": "Updated sales department sender profile",
    "short_name": "SALES",
    "status": "approved",
    "created_at": "2026-06-17T16:01:15.047817+00:00",
    "updated_at": "2026-09-17T16:01:15.0478178+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": "organization",
    "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": null,
    "billing_contact": null,
    "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-09-17T16:01:15.0478182+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-09-17T16:01:15.0478194+00:00",
    "version": "v3"
  }
}

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Request validation failed",
    "details": {
      "brand": [
        "Cannot provide brand data when inherit_tcr_brand is true."
      ],
      "payment_details.expiry": [
        "payment_details.expiry must be in MM/YY format (e.g. '09/27')"
      ]
    },
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-09-17T16:01:15.0478245+00:00",
    "version": "v3"
  }
}

Empty

{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_014",
    "message": "Profile not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-09-17T16:01:15.0478304+00:00",
    "version": "v3"
  }
}

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "Failed to update profile. Please contact support with request ID: req_7X9zKp2jDw",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-09-17T16:01:15.0478309+00:00",
    "version": "v3"
  }
}

Update profile settings

Brand Management

Payment Details

Deprecated fields

Request Body

Response Body

200application/json

400application/json

401

403

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`