API referenceCampaigns
Create
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
flow?string
Value in
- "classic"
- "tree_v3"
timeZone?string
dropDate?string
opensAt?string
lastRideAt?string
afternoonFrom?string
eveningFrom?string
morningAfterAt?string
launchAt?string
retireAfterDays?integer
Range
0 <= value <= 365doorDropoff?boolean
launchIncludeNotHooked?boolean
placeholders?
codes?
name*string
Length
1 <= length <= 120inboundNumber?string
Match
^\+[1-9]\d{6,14}$keyword?string
Length
1 <= length <= 20city?string
Length
1 <= length <= 80region?string
Match
^[A-Z]{2}$provider?string
Value in
- "vonage"
- "twilio"
- "mock"
providerCredentialsId?string
Length
1 <= lengthcapacityTotal?integer
Range
0 <= value <= 9007199254740991liveFrom?string
Format
date-timeliveUntil?string
Format
date-timeaskName?boolean
retention?string
Value in
- "keep"
- "purge_after_delivery"
- "purge_end_of_day"
Response Body
application/json
curl -X POST "https://example.com/campaigns/create" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'null