Crear Contactos

Aquí encontraras información de como importar un contacto o varios contactos en B2Chat.

Validaciones generales

Cada atributo debe contener menos de 200 caracteres.

Formato contact.mobile +<código_país><número_de_móvil> p.ej. [phone].

contact.fullname debe ser una cadena de caracteres de menos de 200 caracteres.

Los contact.custom_attributes ya están registrados en el sistema mediante la consola de administración de B2Chat.

Los contact.custom_attributes contienen valores y tipos de datos correctos para cada atributo registrado en el sistema.

• Campos opcionales

contact.landline, contact.email, contact.identification, contact.address, contact.country ISO code (https://countrycode.org), contact.city, contact.company, contact.custom_attribute, skip_required_custom_attributes colocar en false si quieres que un contacto no se inserte si no tiene un atributo personalizado requerido.

Endpoint de creación de contactos:

https://api.b2chat.io/contacts/import

Crear contacto

POST https://api.b2chat.io/contacts/import

Este método te permitirá crear un contacto en especifico o varios contactos con todo los datos necesarios.

Headers

Name	Type	Description
Content-Type*	application/json
Authorization*	Bearer {{token}}

Request Body

Name	Type	Description
contact.mobile	Numero movil	Debe ser un campo de tipo movil valido para WhatsApp con el formato +<código_país><número_de_móvil> p.ej. [phone]
skip_required_custom_attributes	Boolean	Al colocarlo en FALSE el contacto no se importe si no tiene un campo personalizado requerido. En TRUE permite importar un contacto aunque no se envíe en el body los campos personalizados requeridos. Por defecto esta en TRUE.
contact.fullname	String	Permite máximo 200 caracteres.
contact.landline	Numerico	Permite incluir el teléfono fijo.
contact.email	String	Campo correo de maximo 200 caracteres.
contact.identification	String	Campo asociado a la identificacion del contacto maximo 200 caracteres.
contact.address	String	Campo asociado a la direccion del contacto maximo 200 caracteres.
contact.country	ISO Code	Campo que recibe el codigo ISO del pais, revisar codigos ISO en (https://countrycode.org)
contact.city	String	Campo asociado a la ciudad del contacto maximo 200 caracteres.
contact.company	String	Campo asociado a la compania o empresa del contacto, maximo 200 caracteres.
contact.custom_attribute	Array	Permite enviar un arreglo de campos personalizados creados previamente en la administracion de B2Chat, el arreglo debe tener el nombre del campo y el valor de cada campo personalizado que se desee registrar al contacto.
skip_errors	Boolean	En true permite saltar valores y seguir importando contactos.

200: OK Respuesta exitosa

{
  "trace_id": "055d87a2-4fd7-4685-b304-ea1cef15ebaa",
  "message": "Contact was imported"
}

400: Bad Request No se importo el/los contactos

{
  "trace_id": "055d87a2-4fd7-4685-b304-ea1cef15ebaa",
  "message": "Contact was not imported",
  "errors": [
    "Mobile has an invalid format",
    "Attributes don't match on the system."
  ]
}

• Ejemplo 1: Crea un contacto con todos su campos estandar y personalizados, validando que todos los campos personalizados requeridos sean guardados correctamente, debido a que el campo skip_required_custom_attributes se encuentra en false.

curl --location --request POST 'https://api.b2chat.io/contacts/import' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
  "skip_required_custom_attributes": false,
	"contact": {
    "fullname": "John Doe",
    "mobile": "[phone]",
    "landline": "2772233",
    "email": "[e-mail]",
    "identification": "0123456789",
    "address": "5th Avenue Building 123",
    "country": "CO",
    "city": "Medellín",
    "company": "B2Chat",
    "custom_attributes": [
      { "name": "color", "value": "red" },
      { "name": "department", "value": "sales" }
    ]
  }
}'

• Ejemplo 2: Crea un contacto solamente con campos estandar y la variable skip_required_custom_attributes en true para que no valide si se registran los campos personalizados requeridos.

curl --location --request POST 'https://api.b2chat.io/contacts/import' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
  "skip_required_custom_attributes": true,
	"contact": {
    "fullname": "John Doe",
    "mobile": "[phone]",
    "landline": "2772233",
    "email": "[e-mail]",
    "identification": "0123456789",
    "address": "5th Avenue Building 123",
    "country": "CO",
    "city": "Medellín",
    "company": "B2Chat"
  }
}'

• Ejemplo 3: Creo dos contactos omitiendo errores para continuar la importación y omitiendo los campos requeridos.

curl --location --request POST 'https://api.b2chat.io/contacts/import' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
  "skip_required_custom_attributes": true,
  "skip_errors": true,
  "contact": [{
    "fullname": "John Doe",
    "mobile": "[phone]",
    "landline": "2772233",
    "email": "[e-mail]",
    "identification": "0123456789",
    "address": "5th Avenue Building 123",
    "country": "CO",
    "city": "Medellín",
    "company": "B2Chat",
    "custom_attributes": [
      { "name": "color", "value": "red" },
      { "name": "department", "value": "sales" }
    ]
  },
  {
    "fullname": "August Bchat",
    "mobile": "[phone]",
    "landline": "123456",
    "email": "[e-mail]",
    "identification": "0123456789",
    "address": "6th Avenue 123",
    "country": "CO",
    "city": "Medellín",
    "company": "Acme",
    "custom_attributes": [
      { "name": "color", "value": "green" },
      { "name": "department", "value": "support" }
    ]
  }
  ]
}'

• Ejemplo de respuesta exitosa

#200
{
  "trace_id": "055d87a2-4fd7-4685-b304-ea1cef15ebaa",
  "message": "Contact was imported"
}

• Ejemplo de respuesta con error

#400
{
  "trace_id": "055d87a2-4fd7-4685-b304-ea1cef15ebaa",
  "message": "Contact was not imported",
  "errors": [
    "Mobile has an invalid format",
    "Attributes don't match on the system."
  ]
}