latestOpenAPI 3.1.02026-08-13511119.5 KB

e91a4f756dfe

Campaigns

Create a campaign

Creates a campaign in a workspace. description is supplied as plain text and stored as rich text. Subject to the workspace campaign plan limit.

post/campaigns

Request body

workspaceIdstring required

namestring required

status'active' | 'archived' | 'paused' | 'planned' | 'completed'

icon'star' | 'bulb' | 'calendar' | 'apple' | 'gift' | 'christmasTree' | 'glass' | 'eggCracked' | 'archive' | 'ghost' | 'cross' | 'candle' | 'home' | 'briefcase' | 'school' | 'camera' | 'bike' | 'bell' | 'barbell' | 'barrier' | 'paint' | 'bolt' | 'heart' | 'babyCarriage' | 'trophy' | 'award' | 'paw' | 'bone' | 'creditCard' | 'discount' | 'shield' | 'tag' | 'thumbUp' | 'thumbDown' | 'umbrella' | 'flag' | 'sun' | 'campfire' | 'seeding' | 'leaf' | 'cherry' | 'macro' | 'clover' | 'pumpkin' | 'flame' | 'cactus' | 'globe' | 'stack' | 'basketball' | 'baseball' | 'ball' | 'gasPump' | 'car' | 'balloon' | 'mug' | 'location' | 'analyze' | 'chartPie' | 'chartDots' | 'cards' | 'mail' | 'headphones' | 'microphone' | 'key'

colorstring

startedAtstring date-time

endedAtstring date-time

descriptionstring

Response

Campaign created