Plazbot
  1. Contact
Plazbot
  • Plazbot Developer Hub
  • Automation
    • Update Agente IA Prompt
      POST
  • Contact
    • Get Contacts
      GET
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contact By Id
      GET
    • Get Contact By Email
      GET
    • Get Contact By Phone
      GET
    • Update Activities to Contact
      POST
  • Message
    • Send Message Whatsapp
      POST
    • List Conversation
      GET
    • Send Conversation
      POST
  • Opportunity
    • Get Opportunity
      GET
    • Create Opportunity
      POST
    • Get Opportunity by Id
      GET
    • Delete Opportunity
      DELETE
    • Create Activity for Opportunity
      POST
  • Task
    • Create Task
      POST
    • Get Task By Id
      GET
    • Delete Task
      DELETE
  • User
    • Create User
      POST
    • Get Information by Email
      GET
    • Login Access
      POST
    • Send Reset Password
      POST
    • Update Password
      POST
  • Workspace
    • Get Workspace by ID
  1. Contact

Create Contact

POST
/api/contact
contact
Servicio para poder crear los contactos en el Workspace. Este servicio cuenta con una condicional en el campo de platformId. En caso se decida colocar el platformId con el codigo de Whatsapp, se debe de enviar el internalWhatsappNumber del contacto. En caso se coloque otro canal, se debe de colocar el campo Email.
Codigos de los Canales.
webchat = 1
whatsapp = 2
messenger = 3
instagram = 4
telegram = 5
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.plazbot.com/api/contact' \
--header 'x-workspace-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workspaceId": "string",
  "name": "string",
  "lastname": "string",
  "email": "string",
  "platformId": 0,
  "internalWhatsappNumber": "string",
  "stageId": ""
}'
Response Response Example
{
  "success": true,
  "code": 200,
  "errorCode": null,
  "message": "The contact was registered successfully.",
  "data": {
    "id": "string",
    "contact": {
      "id": "string",
      "creationDate": "2025-04-07T21:56:19.3254439Z",
      "assignedAgentId": null,
      "assignedAgentName": null,
      "segmentationId": null,
      "lastMessage": null,
      "lastMessageDate": "2025-04-07T21:56:19.3254057Z",
      "platformSenderId": null,
      "platformSenderName": "",
      "platformSenderPhone": null,
      "isRead": false,
      "isBotEnabled": true,
      "isManuallyAdded": true,
      "avatarColor": null,
      "orderInCards": 0,
      "orderInCardsLastUpdated": "2025-04-07T21:56:19.3254842Z",
      "tags": [],
      "files": [],
      "variables": [],
      "isSolved": false,
      "solvedByAgentId": null,
      "solvedDate": null,
      "workspaceId": "string",
      "internalWhatsappNumber": "string",
      "name": "string",
      "lastname": "string",
      "email": "string",
      "platformId": 0,
      "stageId": null
    }
  }
}

Request

Header Params
x-workspace-id
string 
required
Body Params application/json
workspaceId
string 
required
Workspace ID
name
string 
required
Nombre del Contacto
lastname
string 
required
Apellidos del Contacto
email
string 
required
Correo del Contacto
platformId
integer 
required
Id de Canal
internalWhatsappNumber
string 
required
Numero de Celular del Contacto. (Ej: 571234567)
stageId
string 
required
Obtener los codigos del servicio del Get Workspace Id
isoCountryCode
string 
required
Es obligatorio cuando pone id de Canal Whatsapp.
ej: PE, US, ES, CO.
Examples

Responses

🟢200OK
application/json
OK
Body
success
boolean 
required
code
integer 
required
errorCode
null 
required
message
string 
required
data
object 
required
id
string 
required
contact
object 
required
workspaceId
string 
required
continuationToken
null 
required
data
array[string]
required
Previous
Get Contacts
Next
Update Contact
Built with