Skip to main content
POST
/
api
/
v1
/
campaigns
Criar nova campanha de ligações
curl --request POST \
  --url https://api.useintegra.com.br/api/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Campanha Março 2026",
  "project_id": "b9c80a57-fad2-41a0-a304-727337ad1b1f",
  "agent_id": "7e09d093-904a-48de-ac49-b0445906c38e",
  "phone_number_id": "d1082e49-1b2c-4337-81e2-8eb74810351d",
  "scheduled_at": "2026-03-25T14:00:00Z",
  "recipients": [
    {
      "phone_number": "+5511999999999",
      "recipient_name": "João Silva",
      "dynamic_variables": {
        "leadName": "Joao",
        "companyName": "Acme Corp"
      }
    },
    {
      "phone_number": "+5511888888888",
      "recipient_name": "Maria Santos",
      "dynamic_variables": {
        "leadName": "Maria",
        "companyName": "Beta Ltd"
      }
    }
  ],
  "config": {
    "call_timeout": 45,
    "voicemail_mode": "hangup",
    "outbound_auto_greet": true,
    "max_concurrent": 2
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "total_recipients": 123,
  "scheduled_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.useintegra.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Body

application/json
name
string
required

Nome da campanha

Minimum string length: 1
Example:

"Campanha Março 2026"

project_id
string<uuid>
required

ID do projeto (copie do Panel → header do projeto)

Example:

"b9c80a57-fad2-41a0-a304-727337ad1b1f"

agent_id
string<uuid>
required

ID do agente que fará as ligações (copie do Panel → card do agente)

Example:

"7e09d093-904a-48de-ac49-b0445906c38e"

phone_number_id
string<uuid>
required

ID do número de telefone de origem

Example:

"d1082e49-1b2c-4337-81e2-8eb74810351d"

scheduled_at
string<date-time>
required

Data/hora para iniciar as ligações (ISO 8601 com timezone)

Example:

"2026-03-25T14:00:00Z"

recipients
object[]
required

Lista de destinatários (max 10.000)

Required array length: 1 - 10000 elements
config
object

Configurações opcionais da campanha

Response

Campanha criada com sucesso

id
string<uuid>

ID da campanha criada

name
string
status
enum<string>
Available options:
PENDING
total_recipients
integer
scheduled_at
string<date-time>
created_at
string<date-time>