Skip to main content
POST
/
v1
/
campaigns
/
{campaignId}
/
steps
Criar step da campanha
curl --request POST \
  --url https://api.nuvia.ai/v1/campaigns/{campaignId}/steps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "action_config": {
    "template_name": "<string>",
    "language_code": "pt_BR",
    "components": [
      {
        "index": "<string>",
        "parameters": [
          {
            "image": {
              "link": "<string>",
              "id": "<string>"
            },
            "document": {
              "link": "<string>",
              "filename": "<string>"
            },
            "video": {
              "link": "<string>"
            },
            "text": "<string>",
            "value": "<string>",
            "link": "<string>",
            "imageUrl": "<string>",
            "imageId": "<string>",
            "documentUrl": "<string>",
            "documentFilename": "<string>",
            "videoUrl": "<string>",
            "currencyCode": "<string>",
            "currencyAmount": 123,
            "dateTime": "<string>",
            "payload": "<string>",
            "parameter_name": "<string>",
            "variable_ref": "<string>"
          }
        ]
      }
    ],
    "text_content": "<string>"
  },
  "send_config": {
    "inbox_id": "<string>",
    "agent_to_activate": "<string>"
  },
  "order": 0
}
'
{
  "_id": {},
  "campaign": {},
  "company": {},
  "order": 123,
  "name": "<string>",
  "action_config": {},
  "send_config": {},
  "delay_config": {},
  "deleted_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

Path Parameters

campaignId
string
required

ID da campanha

Body

application/json
name
string
required
Required string length: 1 - 100
action_type
enum<string>
required
Available options:
TEMPLATE,
TEXT
action_config
object
required
send_config
object
required
order
integer
default:0
Required range: 0 <= x <= 9007199254740991
delay_config
object

Response

201 - application/json
_id
object
required
campaign
object
required
company
object
required
order
number
required
name
string
required
action_type
enum<string>
required
Available options:
TEMPLATE,
TEXT
action_config
object
required
send_config
object
required
status
enum<string>
required
Available options:
active,
paused,
deleted
delay_config
object
deleted_at
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>