---
title: "Register Campaign"
method: POST
path: "/api/v1/compliance/campaign"
tags: ["Campaign"]
---

# Register Campaign

`POST /api/v1/compliance/campaign`

## Request body

- CampaignRegistrationRequest
  - `brand_id` string, required
  - `usecase` 'ACCOUNT_NOTIFICATION' | 'AGENTS_FRANCHISES' | 'CARRIER_EXEMPT' | 'CHARITY' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'EMERGENCY' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'K12_EDUCATION' | 'LOW_VOLUME' | 'MARKETING' | 'MIXED' | 'POLITICAL' | 'POLLING_VOTING' | 'PROXY' | 'PUBLIC_SAFETY_RESTRICTED' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT' | 'SOCIAL' | 'SWEEPSTAKE' | '2FA' | 'UCAAS_LOW' | 'M2M' | 'SOLE_PROPRIETOR' | 'TRIAL' | 'UCAAS_HIGH', required
  - `description` string, required
  - `message_flow` string, required
  - `help_message` string, required
  - `sample1` string, required
  - `sample2` string, required
  - `sample3` string, required
  - `sample4` string, required
  - `sample5` string, nullable
  - `optin_keywords` string, required
  - `optout_keywords` string, required
  - `help_keywords` string, required
  - `optin_message` string, required
  - `optout_message` string, required
  - `embedded_link` boolean
  - `embedded_link_sample` string, nullable
  - `embedded_phone` boolean
  - `age_gated` boolean
  - `direct_lending` boolean
  - `privacy_policy_link` string, required
  - `terms_and_conditions_link` string, required
  - `sub_usecases` string[], nullable

## Response `201`

Successful Response

- CampaignRegistrationResponse
  - `brandId` string, required
  - `campaignId` string, required
  - `cspId` string, required
  - `description` string, required
  - `mock` boolean, required
  - `subUsecases` string[], required
  - `termsAndConditions` boolean, required
  - `usecase` string, required
  - `ageGated` boolean, nullable
  - `autoRenewal` boolean, nullable
  - `billedDate` string, nullable
  - `brandDisplayName` string, nullable
  - `campaignStatus` 'TCR_PENDING' | 'TCR_SUSPENDED' | 'TCR_EXPIRED' | 'TCR_ACCEPTED' | 'TCR_FAILED' | 'CSP_ACCEPTED' | 'CSP_FAILED' | 'MNO_PENDING' | 'MNO_ACCEPTED' | 'MNO_REJECTED' | 'MNO_PROVISIONED' | 'MNO_PROVISIONING_FAILED', nullable — Campaign status
  - `createDate` string, nullable
  - `directLending` boolean, nullable
  - `embeddedLink` boolean, nullable
  - `embeddedLinkSample` string, nullable
  - `embeddedPhone` boolean, nullable
  - `failureReasons` union
    - string
    - RegistryFailureReason[]
      - `fields` string[]
      - `description` string, nullable
  - `helpKeywords` string, nullable
  - `helpMessage` string, nullable
  - `isTMobileNumberPoolingEnabled` boolean, nullable
  - `isTMobileRegistered` boolean, nullable
  - `isTMobileSuspended` boolean, nullable
  - `messageFlow` string, nullable
  - `nextRenewalOrExpirationDate` string, nullable
  - `numberPool` boolean, nullable
  - `optinKeywords` string, nullable
  - `optinMessage` string, nullable
  - `optoutKeywords` string, nullable
  - `optoutMessage` string, nullable
  - `privacyPolicyLink` string, nullable
  - `referenceId` string, nullable
  - `resellerId` string, nullable
  - `sample1` string, nullable
  - `sample2` string, nullable
  - `sample3` string, nullable
  - `sample4` string, nullable
  - `sample5` string, nullable
  - `status` string, nullable
  - `submissionStatus` 'CREATED' | 'FAILED' | 'PENDING', nullable
  - `subscriberHelp` boolean, nullable
  - `subscriberOptin` boolean, nullable
  - `subscriberOptout` boolean, nullable
  - `tcrBrandId` string, nullable
  - `tcrCampaignId` string, nullable
  - `termsAndConditionsLink` string, nullable
  - `vertical` string, nullable
  - `webhookFailoverURL` string, nullable
  - `webhookURL` string, nullable

## Other responses

- `422` — Validation Error
- `4XX` — Client error with Support Agent information.
- `5XX` — Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) · [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inkbox/inkbox-api/revisions/31f357e7e6f8/schema)