Get campaigns for a profile's brand

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.

Retrieves all campaigns linked to the profile's brand, including use cases and sample messages. A profile with inherit_tcr_campaign=true gets its organization's campaigns and, beside them, any campaign of its own (added with POST /v3/channels/sms/compliances/US/TEN_DLC/campaigns); isInherited says which is which.

GET
/v3/profiles/{profileId}/campaigns

Path Parameters

profileId*string

Profile ID from route

Formatuuid

Header Parameters

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

Response Body

Campaigns retrieved successfully

application/json
  1. response

Standard API response envelope for all v3 endpoints

success?boolean

Indicates whether the request was successful

data?array<>|

The response data (null if error)

error?|null

Error details (null if successful)

meta?

Metadata about the request and response

Example Request
curl -X GET 'https://api.sent.dm/v3/profiles/770e8400-e29b-41d4-a716-446655440002/campaigns'
Example Response
{  "success": true,  "data": [    {      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",      "customerId": "00000000-0000-0000-0000-000000000000",      "isInherited": false,      "type": "App",      "name": "Customer Notifications",      "description": "Appointment reminders and account notifications",      "brandId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "status": null,      "tcrCampaignId": null,      "submittedToTCR": false,      "submittedAt": null,      "cost": null,      "billedDate": null,      "messageFlow": "User signs up on website and opts in to receive SMS notifications",      "volume": null,      "privacyPolicyLink": null,      "termsAndConditionsLink": null,      "optinMessage": null,      "optoutMessage": null,      "helpMessage": null,      "optinKeywords": null,      "optoutKeywords": null,      "helpKeywords": null,      "dcaElectionsComplete": null,      "dcaElectionsCompletedAt": null,      "tcrSyncError": null,      "hasSubmissionTransaction": false,      "useCases": [        {          "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",          "campaignId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",          "customerId": "00000000-0000-0000-0000-000000000000",          "messagingUseCaseUs": "ACCOUNT_NOTIFICATION",          "sampleMessages": [            "Hi {name}, your appointment is confirmed for {date} at {time}.",            "Your order #{order_id} has been shipped. Track at {url}"          ],          "createdAt": "0001-01-01T00:00:00+00:00",          "updatedAt": null        }      ],      "createdAt": "2026-11-12T15:32:26.8911987+00:00",      "updatedAt": null    }  ],  "error": null,  "meta": {    "request_id": "req_7X9zKp2jDw",    "timestamp": "2026-11-12T15:32:26.8911996+00:00",    "version": "v3"  }}

Complete profile setup POST

**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. Final step in the profile compliance workflow. Validates all prerequisites (KYC, brand, campaigns, required documents), connects the profile to the SMS and WhatsApp channels, and marks it onboarded. Prerequisites are always validated first: if any fail the call returns 400 naming every unmet one, and nothing is started. If they pass and the profile is already onboarded, the call returns 200 and does nothing. Otherwise it returns 202 and calls the provided webhook URL when background processing finishes. Callable with the organization's API key or the profile's own key. The key's user must be an admin or owner of the profile, or of the organization it belongs to. Prerequisites (all but the last are checked before the already-onboarded short-circuit, matching the previous contract; the last is checked after it, so a profile that is already onboarded is never rejected by it): - Profile must have a name, short name, and description (short name max 50 characters, description max 5000) - webHookUrl must be supplied on the request - A KYC form submission is required - A brand is required, either on the profile or inherited from the parent organization - TCR applications must have at least one campaign, own or inherited - Destination countries marked as main must have their required compliance documents uploaded - TCR applications must state whether they inherit the organization's TCR brand and campaign Outcome: - Once the prerequisites pass and background processing succeeds, the profile's conversionFlowStatus becomes ONBOARDED and its public status reads `approved` - A profile with no WhatsApp channel, or one still awaiting TCR registration or country documents, is onboarded like any other. Those are answered by the brand and campaign records, not by a status on the profile - If background processing fails, the profile keeps the status it already had and the webhook reports the reason

Create a campaign for a profile's brand POST

**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 campaign scoped under the brand of the specified profile. Each campaign must include at least one use case with sample messages.