Skip to main content
POST
/
v1
/
10dlc
/
campaigns
Create 10DLC campaign
curl --request POST \
  --url https://api.zavu.dev/v1/10dlc/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brandId": "brand_abc123",
  "name": "Order Notifications",
  "useCase": "ACCOUNT_NOTIFICATION",
  "description": "Send order status updates and shipping notifications to customers who opted in.",
  "sampleMessages": [
    "Hi {{name}}, your order #{{order_id}} has shipped! Track it at {{url}}",
    "Your order #{{order_id}} has been delivered. Thank you for your purchase!"
  ],
  "subscriberOptIn": true,
  "subscriberOptOut": true,
  "subscriberHelp": true,
  "numberPooling": false,
  "directLending": false,
  "embeddedLink": true,
  "embeddedPhone": false,
  "affiliateMarketing": false,
  "ageGated": false
}
'
{
  "campaign": {
    "id": "<string>",
    "brandId": "<string>",
    "name": "Order Notifications",
    "useCase": "ACCOUNT_NOTIFICATION",
    "description": "<string>",
    "sampleMessages": [
      "<string>"
    ],
    "subscriberOptIn": true,
    "subscriberOptOut": true,
    "subscriberHelp": true,
    "numberPooling": true,
    "directLending": true,
    "embeddedLink": true,
    "embeddedPhone": true,
    "affiliateMarketing": true,
    "ageGated": true,
    "status": "draft",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "subUseCases": [
      "<string>"
    ],
    "messageFlow": "<string>",
    "helpMessage": "<string>",
    "optInKeywords": [
      "<string>"
    ],
    "optOutKeywords": [
      "<string>"
    ],
    "dailyLimit": 123,
    "failureReason": "<string>",
    "registrationCostCents": 123,
    "monthlyFeeCents": 123,
    "submittedAt": "2023-11-07T05:31:56Z",
    "approvedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
brandId
string
required

ID of the brand to create this campaign under.

​
name
string
required
Maximum string length: 100
​
useCase
string
required

Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).

Maximum string length: 50
​
description
string
required
Maximum string length: 4096
​
sampleMessages
string[]
required
Required array length: 1 - 5 elements
Maximum string length: 1024
​
subscriberOptIn
boolean
required
​
subscriberOptOut
boolean
required
​
subscriberHelp
boolean
required
​
numberPooling
boolean
required
​
directLending
boolean
required
​
embeddedLink
boolean
required
​
embeddedPhone
boolean
required
​
affiliateMarketing
boolean
required
​
ageGated
boolean
required
​
subUseCases
string[]
​
messageFlow
string
Maximum string length: 2048
​
helpMessage
string
Maximum string length: 500
​
optInKeywords
string[]
Maximum string length: 50
​
optOutKeywords
string[]
Maximum string length: 50

Response

Campaign created in draft status.

​
campaign
object
required