Get campaigns for a profile's brand

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. Returns inherited campaigns if inherit_tcr_campaign=true.

GET
/v3/profiles/{profileId}/campaigns

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v3/profiles/770e8400-e29b-41d4-a716-446655440002/campaigns"
{
  "success": true,
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "customerId": "00000000-0000-0000-0000-000000000000",
      "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-09-17T16:01:15.1874608+00:00",
      "updatedAt": null
    }
  ],
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-09-17T16:01:15.1874619+00:00",
    "version": "v3"
  }
}
Empty
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_009",
    "message": "Brand not found for this profile",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-09-17T16:01:15.1874635+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "Failed to retrieve campaigns. 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.1874643+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.