Este artículo, te mostraremos como hacer consultas a la entidad Contactos, basándonos para estos ejemplos en https://www.postman.com/
Direcciones
Puedes hacer consultas del tipo GET, DEL, POST Y PUT a las direcciones de los contactos.
Traer la dirección de un contacto.
Donde contact_id es un integer.
Borrar la dirección de un contacto.
Donde contact_id es un integer y address_id es {{address-id}}
Cargar la dirección de un contacto.
Donde contact_id es un integer
Y un Body, raw en formato JSON con la dirección:
{
"type": 5,
"street": "Calle de la API, 8",
"city": "Almería",
"state": "Almería",
"country": "España",
"postal_code": "04001"
}
Editar la dirección de un contacto.
Donde contact_id es un integer y address_id es {{address-id}}
Y un Body, raw en formato JSON con la dirección:
{
"type": 5,
"street": "Calle modificada por API, 7",
"city": "Almería",
"state": "Almería",
"country": "España",
"postal_code": "04001"
}
Etiquetas
Puedes hacer consultas del tipo GET, DEL, POST Y PUT a las etiquetas de los contactos.
Traer una lista de todas las etiquetas de un contacto.
Donde contact_id es un integer
Traer una lista de todas las etiquetas que tienen todos los contactos.
Eliminar la etiqueta de un contacto.
Donde contact_id y tag_i son integer
Agregar etiqueta a un contacto.
Donde contact_id es un integer
Y un Body, raw del formato JSON con la etiqueta:
{
"name":"api test"
}
Modificar la etiqueta de un contacto.
Donde contact_id y tag_i son integer
Y un Body, raw del formato JSON con la etiqueta:
{
"name":"clientify"
}
Emails
Puedes hacer consultas del tipo GET, DEL, POST Y PUT a las etiquetas de los contactos.
Nombre | Tipo | Descripcion |
type | int | tipo de email |
string | dirección email |
Lista de opciones disponibles para el campo type:
Identificador | Tipo |
1 | Trabajo |
2 | Personal |
3 | Otro |
4 | Principal |
Traer la lista de emails de un contacto.
Donde contact_id es un integer
Borrar email de un contacto.
Donde contact_id e id_email es un integer
Colocar un email a un contacto.
Donde contact_id es un integer
Y un Body, raw en formato JSON:
{
"type": 4,
"email": "[email protected]"
}
Modificar el email de un contacto.
Donde contact_id e id_email es un integer
Y un Body, raw en formato JSON:
{
"type": 4,
"email": "[email protected]"
}
Teléfonos
Puedes hacer consultas del tipo GET, DEL, POST Y PUT a los teléfonos de los contactos.
Traer una lista de los números de un contacto.
Donde contact_id es un integer
Eliminar un número de un contacto.
Donde contact_id e id_phone es un integer
Agregar un número a un contacto.
Donde contact_id es un integer
Y un body, raw en formato JSON:
{
"type": 1,
"phone": "+345554872"
}
Modificar el número de un contacto.
Donde contact_id e id_phone es un integer
Y un Body, raw en formato JSON:
{
"id": 40,
"type": 1,
"phone": "+34555444333"
}
Contactos
Puedes hacer consultas del tipo GET, DEL, POST Y PUT a los contactos.
Nombre | Tipo | Descripcion |
id | integer | ID del contacto |
owner | string | usuario del propietario del contacto |
first_name | string | primer nombre |
last_name | string | apellido |
phones | array | array de |
company | string | empresa |
addresses | array | array de |
emails | array | array de emails del contacto |
websites | array | array de |
status | string | Stores the contact |
picture_url | string | url de la foto del contacto |
title | string | titulo |
summary | string | Summary |
description | string | descripción |
remarks | string | observaciones |
message | string | mensaje que se mostrara en el muro del contacto |
lead_scoring | integer | puntos de lead scoring |
deals | array | array de deals |
taxpayer_identification_number | string | Taxpayer identification nummber |
related_tasks | array | array de |
tags | array | array de strings de etiquetas del contacto |
custom_fields | array | array de |
gdpr_accept | bool | True si el cliente acepto el GDPR si no False |
contact_source | string | origen del contacto |
medium | string | Contact Medium |
contact_type | string | tipo de contacto |
birthday | date | cumpleaños |
last_contact | date | ultimo contacto |
created | date | fecha de creación |
visitor_key | string | Visitor key regtrieved from the vk generated by the tracking code |
pinterest_url | string | URL de Pinterest |
twitter_url | string | URL de twitter |
facebook_url | string | url de facebook |
linkedin_url | string | URL de Linkedin |
googleplus_url | string | URL de Google Plus |
foursquare_url | string | Foursquare id |
klout_url | string | url of the klout picture for the contact |
skype_username | string | usuario de Skype |
twitter_id | string | Id de twitter |
google_id | string | Google id |
facebook_id | string | Facebook id |
linkedin_id | string | Linkedin id |
facebook_picture_url | string | url de imagen de facebook |
twitter_picture_url | string | url de imagen de twitter |
linkedin_picture_url | string | url de imagen de Linkedin |
assignment_type | string | If you are going to use round robin owner assignment set this field to "basic" |
autoassignment_users | string | String with the list of usernames separated by comma (,) to apply the autoassignment |
Traer todos los contactos del usuario.
La paginación es de máximo 100 contactos por página.
Traer por query los contactos según un nombre.
Traer por query los contactos según nombre y teléfono.
Traer por query los contactos por origen.
Traer por query los contactos que tienen un campo personalizado con un valor específico.
Traer por query los contactos en los que el valor específico es mayor a un número.
Traer por query los contactos en los que el valor específico es igual o mayor a un número.
Traer por query todos los contactos que sean mayores a X y menores que Y.
Crear un contacto.
Y un Body, raw del formato JSON:
{
"first_name": "Darrin",
"last_name": "Brown",
"email": "[email protected]",
"phone": "78-254-915-9593",
"status": "warm-lead",
"title": "Dynamic Functionality Developer",
"company": "Leuschke - Miller",
"contact_type": "",
"contact_source": "",
"addresses": [{"street":"72883 Hodkiewicz Crest", "city":"Eliville", "state":"Galicia", "country":"Spain", "postal_code":"34001", "type":1}],
"custom_fields": [],
"description": "Description you can add to the contact",
"remarks": "Just remarks",
"summary": "Summary for the contact",
"message": "Text to show in the contact wall",
"re_property_name": "Hakeem Hicks",
"tags": ["test"],
"last_contact": null,
"gdpr_accept": true
}
Generar usuarios por lote.
Y un Body, raw del formato JSON:
[{
"first_name": "Batchie",
"last_name": "Contact 1",
"email": "[email protected]",
"phone": "+34 618 353 458"
}, {
"first_name": "Dude",
"last_name": "Contact 2",
"email": "[email protected]",
"phone": "+1 353-6458"
}, {
"first_name": "Guybrush",
"last_name": "Tripwood",
"email": "[email protected]",
"phone": "923 35 36 58"
}]
Traer la información de un contacto.
Donde contact_id es un integer
Editar detalles de un contacto.
Donde contact_id es un integer
Y un Body, raw del formato JSON:
{
"first_name": "Paco",
"last_name": "Merlo"
}
Eliminar un contacto.
Donde contact_id es un integer
Añadir una nota a un contacto.
Donde contact_id es un integer
Y un Body, raw donde el formato sea JSON:
{
"name": "Note name",
"comment": "Meeting agended"
}
Añadir llamada a contacto.
Donde contact_id es un integer
Y un Body, raw en formato JSON:
{
"type":"incoming","comment":"Meeting agended",
"outcome":"not_interested",
"call_date":"2020-11-17",
"call_time":"17:00:00+0100"
}
Añadir reunion a contacto.
Donde contact_id es un integer
Y un Body, raw en formato JSON:
{
"type": "virtual",
"comment": "Virtual scheduled meeting from postman",
"outcome": "scheduled",
"date": "2021-07-08 12:34"
}
Asignar un propietario a un contacto.
Donde contact_id es un integer
Y un Body, raw en formato JSON:
{
"owner": integer
}
El ID en enteros de cada una de las entidades lo puedes obtener de su respectiva consulta.