Skip to main content
POST
/
api
/
conversation
/
campaign
Crear Campana
curl --request POST \
  --url https://api.plazbot.com/api/conversation/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "name": "<string>",
  "templateId": "<string>",
  "contacts": [
    "<string>"
  ],
  "workspaceId": "<string>"
}
'
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization
string
header
required

Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login

Headers

x-workspace-id
string
required

Identificador del workspace

Body

application/json
name
string
required

Nombre de la campana

templateId
string
required

ID de la plantilla a utilizar

contacts
string[]
required

Lista de IDs de contactos

workspaceId
string
required

Identificador del workspace

Response

Campana creada exitosamente

success
boolean
required

Indica si la operacion fue exitosa

code
integer
required

Codigo HTTP de la respuesta

errorCode
string | null
required

Codigo de error, null si no hay error

message
string
required

Mensaje descriptivo del resultado

data
object
required

Datos de la respuesta