📣 Campanhas

CampaignCancel

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/cancel/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/cancel/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/cancel/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignContactsAdd

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/contacts/add/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpoobject[]

application/json

namestringOpcional

numberstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/contacts/add/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/contacts/add/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

[
  {
    "name": "Contato 1",
    "number": "5511999990001"
  },
  {
    "name": "Contato 2",
    "number": "5511999990002"
  }
]

200

Successful response

CampaignContactsList

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/contacts/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/campaign/contacts/{campaignId}

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/campaign/contacts/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

CampaignContactsRemove

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

contactIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignContactsRemoveAll

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignCreate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/create

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

startstringOpcional

message1stringOpcional

message2stringOpcional

message3stringOpcional

sessionIdstringOpcional

delaystringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/create

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/create HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "name": "Campanha Teste",
  "start": "2026-04-10T10:00:00.000Z",
  "message1": "Olá {nome}!",
  "message2": "Como vai?",
  "message3": "Até logo!",
  "sessionId": "{{sessionId}}",
  "delay": "5"
}

200

Successful response

CampaignDelete

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/delete/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/delete/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/delete/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignDuplicate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/duplicate/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/duplicate/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/duplicate/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignList

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageintegerOpcionalExample: 1

limitintegerOpcionalExample: 10

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/campaign/list

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/campaign/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

CampaignPause

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/pause/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/pause/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/pause/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignReport

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/report/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/campaign/report/{campaignId}

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/campaign/report/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

CampaignResume

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/resume/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/resume/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/resume/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignSkip

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/skip/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/skip/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/skip/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignStart

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/start/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/start/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/start/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Successful response

CampaignUpdate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/campaign/update/{campaignId}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

campaignIdstringObrigatório

Corpo

application/json

namestringOpcional

startstringOpcional

message1stringOpcional

message2stringOpcional

message3stringOpcional

sessionIdstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/campaign/update/{campaignId}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/campaign/update/{campaignId} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "name": "Campanha Atualizada",
  "start": "2026-04-15T10:00:00.000Z",
  "message1": "Olá!",
  "message2": "Tudo bem?",
  "message3": "Até logo!",
  "sessionId": "{{sessionId}}"
}

200

Successful response