Skip to main content
POST
/
v1
/
campaigns
Criar campanha
curl --request POST \
  --url https://api.notifique.dev/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "channels": [
    "whatsapp"
  ],
  "templateId": "<string>",
  "segmentId": "<string>",
  "audienceContactIds": [
    "<string>"
  ],
  "scheduledFor": "2023-11-07T05:31:56Z",
  "instanceId": "<string>",
  "fromEmail": "<string>",
  "variables": {}
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "DRAFT",
    "templateId": "<string>",
    "channels": [
      "whatsapp"
    ],
    "segmentId": "<string>",
    "audienceContactIds": [
      "<string>"
    ],
    "scheduledFor": "2023-11-07T05:31:56Z",
    "instanceId": "<string>",
    "fromEmail": "<string>",
    "variables": {},
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Body

application/json
name
string
required
Maximum string length: 128
channels
enum<string>[]
required
Minimum array length: 1
Available options:
whatsapp,
sms,
email
templateId
string
segmentId
string
audienceContactIds
string[]
scheduledFor
string<date-time>
instanceId
string
fromEmail
string
variables
object

Response

Criada.

success
boolean
data
object