Profiles
Create a campaign for a profile's brand
Creates a new campaign scoped under the brand of the specified profile. Each campaign must include at least one use case with sample messages.
post/v3/profiles/{profileId}/campaigns
Path parameters
profileIdstring uuid required
Profile ID from route
Headers
Idempotency-Keystring
Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.
x-profile-idstring uuid
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.
Request body
Example request
{
"campaign": {
"name": "Customer Notifications",
"description": "Appointment reminders and account notifications",
"type": "App",
"useCases": [
{
"messagingUseCaseUs": "ACCOUNT_NOTIFICATION",
"sampleMessages": [
"Hi {name}, your appointment is confirmed for {date} at {time}.",
"Your order #{order_id} has been shipped. Track at {url}"
]
}
],
"messageFlow": "User signs up on website and opts in to receive SMS notifications",
"privacyPolicyLink": "https://acmecorp.com/privacy",
"termsAndConditionsLink": "https://acmecorp.com/terms",
"optinMessage": "You have opted in to Acme Corp notifications. Reply STOP to opt out.",
"optoutMessage": "You have been unsubscribed. Reply START to opt back in.",
"helpMessage": "Reply STOP to unsubscribe or contact support@acmecorp.com",
"optinKeywords": "YES, START, SUBSCRIBE",
"optoutKeywords": "STOP, UNSUBSCRIBE, END",
"helpKeywords": "HELP, INFO, SUPPORT"
},
"sandbox": false
}Response
Campaign created successfully