sent-profile-provisioning

Sent Profile Provisioning

This skill is the execution counterpart to profile architecture: once the tenancy boundary is decided, it drives the API calls, the completion callback, the campaign registration, and the user administration that make a profile able to send. Design the boundary with sender-profile-architect first; provision it here.

Provisioning sequence

1. Confirm the credential. POST /v3/profiles requires an organization key with admin. Profile-scoped keys cannot create profiles, and a profile key that sends x-profile-id receives 403.
2. Decide inheritance and sharing before the call. These flags shape compliance posture and are awkward to unwind later.
3. Create the profile, validating the payload with "sandbox": true first when the shape is uncertain. Use a different idempotency key for the live create because a successful sandbox response is cached for 24 hours.
4. Attach or inherit WhatsApp via exactly one of the three supported paths.
5. Register campaigns for US SMS under the profile.
6. Complete the profile with POST /v3/profiles/{profileId}/complete and a reachable webHookUrl.
7. Reconcile status from the callback, or by polling if the callback is missed.
8. Invite users with least-privilege roles.

Create payload essentials

name is the only required field. The consequential optional fields group into identity, sharing, inheritance, billing, WhatsApp, and brand.

{
  "name": "Northwind Retail",
  "short_name": "Northwind",
  "description": "Retail brand tenant",
  "allow_contact_sharing": false,
  "allow_template_sharing": false,
  "inherit_contacts": false,
  "inherit_templates": false,
  "inherit_tcr_brand": true,
  "inherit_tcr_campaign": true,
  "billing_model": "profile",
  "billing_contact": {
    "name": "Ada Ops",
    "email": "[email protected]",
    "phone": "+14155550100",
    "address": "1 Example Way, Springfield"
  },
  "sandbox": true
}

short_name must be 3 to 11 characters of letters, numbers, and spaces with at least one letter. Inheritance flags default to true, so a profile created with no flags consumes the organization's contacts, templates, brand, and campaigns. The example opts into contact and template isolation explicitly while inheriting the organization's compliance registrations. Sharing flags expose this profile's resources outward; inheritance flags consume the organization's resources inward. They are independent directions and are frequently confused.