Skip to main content
POST
/
api
/
contact
Crear Contacto
curl --request POST \
  --url https://api.plazbot.com/api/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "platformId": 123,
  "lastname": "<string>",
  "email": "<string>",
  "internalWhatsappNumber": "<string>",
  "stageId": "<string>",
  "isoCountryCode": "<string>",
  "tags": [
    "<string>"
  ],
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>",
    "contact": {
      "id": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "assignedAgentId": "<string>",
      "assignedAgentName": "<string>",
      "segmentationId": "<string>",
      "lastMessage": "<string>",
      "lastMessageDate": "2023-11-07T05:31:56Z",
      "platformSenderId": "<string>",
      "platformSenderName": "<string>",
      "platformSenderPhone": "<string>",
      "platformSenderEmail": "<string>",
      "isRead": true,
      "isBotEnabled": true,
      "isManuallyAdded": true,
      "avatarColor": "<string>",
      "orderInCards": 123,
      "orderInCardsLastUpdated": "2023-11-07T05:31:56Z",
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>",
          "assignmentDate": "2023-11-07T05:31:56Z"
        }
      ],
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "files": [
        "<string>"
      ],
      "isSolved": true,
      "workspaceId": "<string>",
      "name": "<string>",
      "lastname": "<string>",
      "email": "<string>",
      "platformId": 123,
      "stageId": "<string>",
      "internalWhatsappNumber": "<string>",
      "blocked": true
    }
  }
}

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 fase. 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

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