Campaigns
Create a campaign
Creates an email campaign draft for the given audience and content, returning the created campaign.
POST
Creates an email campaign draft for the given audience and content, returning the created campaign.
apiKeyheader
x-api-key<token>application/json- body
name*stringLength
length <= 120channel*stringValue in
"sms""whatsapp""email"content*||audience*policy?|nullSuccess
application/json- response
id*CampaignIdMatch
^camp_[0-9a-hjkmnp-tv-z]{16,24}$name*stringchannel*stringValue in
"sms""whatsapp""email"content*||audience*policy*definition*latestRun*|nullcreatedBy*string|nullactorEmail*stringmemberRole*stringcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.campaigns.create({ "name": "example", "channel": "sms", "content": { "channel": "email", "email": {} }, "audience": { "topicId": "example" }});Example Response
{ "id": "string", "name": "string", "channel": "sms", "content": { "channel": "email", "email": { "subject": "string", "html": "string", "text": "string", "attachments": [ { "filename": "string", "content": "string", "mediaId": "string", "contentType": "string", "size": 1 } ], "publicationId": "string", "inputContractId": "string", "templateId": "string", "templateSlug": "string", "templateData": { "property1": "string", "property2": "string" }, "locale": "string", "timeZone": "string", "inReplyToMessageId": "string", "replyTo": [ "string" ], "topicId": "string", "tracking": { "opens": true, "clicks": true }, "footer": { "enabled": true }, "headers": { "property1": "string", "property2": "string" }, "preheader": "string" }, "issue": { "path": "string", "commit": "string" }, "from": { "email": "string", "name": "string" }, "replyMailboxId": "string", "conversationId": "string", "metadata": { "property1": "string", "property2": "string" } }, "audience": { "topicId": "string", "includeTags": [ "string" ], "excludeTags": [ "string" ], "contactIds": [ "string" ], "groupIds": [ "string" ] }, "policy": { "pageSize": 100 }, "definition": { "state": "editable", "frozenAt": "string" }, "latestRun": { "id": "string", "status": "scheduled", "scheduledFor": "string", "completedAt": "string", "totalRecipients": 0, "dispatchedCount": 0, "failedCount": 0, "skippedCount": 0, "pendingCount": 0, "estimatedCompletionAt": "string" }, "createdBy": "string", "actorEmail": "string", "memberRole": "string", "createdAt": "string", "updatedAt": "string"}