Skip to main content
POST
/
v1
/
campaigns
Criar nova campanha
curl --request POST \
  --url https://api.nuvia.ai/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "audience_config": {
    "filters": {
      "agent_step_ids": [
        "<string>"
      ],
      "agent_ids": [
        "<string>"
      ],
      "conversation_status": [
        "<string>"
      ],
      "user_ids": [
        "<string>"
      ]
    },
    "contact_ids": [
      "<string>"
    ],
    "lists": [
      {
        "id": "<string>",
        "views": [
          "<string>"
        ]
      }
    ]
  },
  "description": "<string>",
  "trigger_config": {},
  "behavior_config": {
    "ignore_business_hours": true
  },
  "linkedin_config": {
    "first_step_as_invitation": true,
    "send_invite_note": true,
    "invite_note": "<string>"
  }
}
'
{
  "_id": {},
  "company": {},
  "name": "<string>",
  "channel_type": {},
  "trigger_config": {},
  "audience_config": {},
  "metrics": {},
  "description": "<string>",
  "behavior_config": {},
  "linkedin_config": {},
  "last_execution_at": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Body

application/json
name
string
required
Required string length: 1 - 100
channel_type
enum<string>
required
Available options:
WAP_AUTO_CLOSER,
WEB_V2,
EVOLUTION_API,
LINKEDIN,
MULTI_CHANNEL
trigger_type
enum<string>
required
Available options:
MANUAL,
SCHEDULED,
RECURRING,
EXTERNAL_TRIGGER
audience_config
object
required
description
string
Maximum string length: 500
trigger_config
object
behavior_config
object
linkedin_config
object

Response

201 - application/json
_id
object
required
company
object
required
name
string
required
channel_type
object
required
trigger_type
enum<string>
required
Available options:
MANUAL,
SCHEDULED,
RECURRING,
EXTERNAL_TRIGGER
trigger_config
object
required
audience_config
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
metrics
object
required
description
string
behavior_config
object
linkedin_config
object
last_execution_at
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>