POST
/
v3
/
campaigns
curl --request POST \
  --url https://api4.kinbox.com.br/v3/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "channelId": "<string>",
  "operatorName": "<string>",
  "businessHoursId": "<string>",
  "channelType": "1",
  "leadType": "lead",
  "scheduledTo": "<string>",
  "originalScheduledTo": "<string>",
  "finishedAtPrediction": "<string>",
  "leadsAssetUrl": "<string>",
  "message": "<string>",
  "textRaw": "<string>",
  "assetsUrls": [
    "<string>"
  ],
  "chunksCount": 123,
  "secondsBetweenMessages": 123,
  "secondsBetweenChunks": 123,
  "chunkSize": 123,
  "template": {}
}'
{
  "id": "<string>",
  "_id": "<string>",
  "name": "<string>",
  "channelId": "<string>",
  "operatorId": "<string>",
  "operatorName": "<string>",
  "businessHoursId": "<string>",
  "channelType": "1",
  "leadType": "lead",
  "scheduledTo": "<string>",
  "nextScheduledTo": "<string>",
  "originalScheduledTo": "<string>",
  "finishedAtPrediction": "<string>",
  "leadsAssetUrl": "<string>",
  "message": "<string>",
  "textRaw": "<string>",
  "assetsUrls": [
    "<string>"
  ],
  "active": true,
  "shouldCreateConversation": true,
  "status": "processing",
  "chunksCount": 123,
  "leadsCount": 123,
  "secondsBetweenMessages": 123,
  "secondsBetweenChunks": 123,
  "trackAllChannels": true,
  "trackMaxHours": 123,
  "chunkSize": 123,
  "template": {},
  "progress": 123,
  "resultCounts": {
    "sent": 123,
    "received": 123,
    "read": 123,
    "answered": 123,
    "chunksExecuted": 123,
    "byChunkId": {}
  },
  "messagesProcessed": 123,
  "lastMessageProcessedAt": "2023-11-07T05:31:56Z",
  "healthCheckData": {
    "messagesProcessed": 123,
    "lastMessageProcessedAt": "2023-11-07T05:31:56Z",
    "healthCheckExecutions": 123,
    "jobId": "<string>",
    "chunkId": "<string>",
    "nextHealthCheckAt": "2023-11-07T05:31:56Z",
    "lastHealthCheckAt": "2023-11-07T05:31:56Z"
  },
  "workspaceId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdateAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

201 - application/json

The response is of type object.