Skip to main content
POST
Crear Contacto

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
workspaceId
string
required

Identificador del workspace

name
string
required

Nombre del contacto

platformId
integer
required

ID del canal (1=Webchat, 2=WhatsApp, 3=Messenger, 4=Instagram, 5=Telegram, 6=Portal, 7=Code)

lastname
string

Apellido del contacto

email
string | null

Correo electronico del contacto

internalWhatsappNumber
string | null

Numero de WhatsApp del contacto (ej: 57123456789). Obligatorio cuando platformId=2

stageId
string | null

ID de la etapa del contacto. Obtener los codigos del servicio Get Workspace

isoCountryCode
string | null

Indicador de bandera del pais (ej: PE, US, ES, CO)

tags
string[]

IDs de etiquetas a asignar

customFields
object[]

Campos personalizados, se crea en la plataforma en Configuracion -> Variables

Response

Contacto creado 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