Trabajo con una lista de oportunidades

Una oportunidad (deal) es una entidad que agrupa uno o más contactos y tiene un usuario responsable. En la terminología de CRM, esta entidad suele representarse como un “pedido” o simplemente una “oportunidad”.

Subida de la lista de oportunidades

Para subir una lista de oportunidades desde el CRM a Wazzup, se debe enviar una solicitud:

 POST https://api.wazzup24.com/v3/deals

En el cuerpo de la solicitud se debe enviar un arreglo con los datos de las oportunidades. Las oportunidades se comparan por su id: si la oportunidad no existe en Wazzup, se añadirá; si ya existe, se actualizarán sus datos. Puedes subir un máximo de 100 oportunidades por solicitud.

Parámetros de la solicitud
Parámetro

Los parámetros obligatorios están marcados con un asterisco ∗

Tipo Descripción
id* Number ID de la oportunidad. Campo obligatorio, no más de 100 caracteres.
responsibleUserId* String ID del usuario responsable. Llena este campo para que el vendedor responsable vea el diálogo con el contacto de la oportunidad en la ventana de chat de Wazzup.
name* String Nombre de la oportunidad, no más de 200 caracteres.
uri* string Enlace a la oportunidad en el CRM. Si se especifica, en el menú desplegable "Oportunidades", el usuario podrá ver la lista de oportunidades con el contacto en las que es responsable e ir a su página en el CRM. Campo opcional, no más de 200 caracteres.
contacts* Object Arreglo con los ID de los contactos vinculados a la oportunidad. Los ID pueden ser cadenas de texto.
closed* Boolean Indicador que marca si la oportunidad está cerrada.
Ejemplo de solicitud
 curl --location --request POST 'https://api.wazzup24.com/v3/deals'; \
--header 'Authorization: Basic c8cf90444023482f909520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"id": "1",
"responsibleUserId": "id007",
"name": "Daily Deal Test",
"closed": false,
"contacts": ["111-2e0df379-0e3c-470f-9b36"],
"link": "https://link-to-deal-in-crm.com";
}
]
'

Obtención de la lista de oportunidades

Para obtener la lista de ofertas, envíe una solicitud GET a https://api.wazzup24.com/v3/deals. Puede obtener hasta 100 registros con una sola solicitud.

 GET https://api.wazzup24.com/v3/deals?offset=
Ejemplo de solicitud
 curl --location --request GET 'https://api.wazzup24.com/v3/deals' \

--header 'Authorization: Bearer c8cf90474023482f909520d45f368d27'
Respuesta

Los datos del resultado se devolverán como un arreglo de objetos con los siguientes parámetros:

Parámetro Tipo Descripción
count Number Cantidad de oportunidades en la respuesta.
data Object  Arreglo con los datos de las oportunidades.
data.id String ID de la oportunidad. No más de 100 caracteres.
data.responsibleUserId String ID del usuario responsable. No más de 100 caracteres. Necesario para mostrar el diálogo con un contacto de la oportunidad al usuario responsable en los chats de Wazzup.
data.name String Nombre de la oportunidad. No más de 200 caracteres.
data.contacts Object Arreglo con los ID de los contactos asociados a la oportunidad (máximo 10).
data.uri String Enlace a la oportunidad en el CRM. No más de 200 caracteres. Si se especifica, en el menú desplegable "Oportunidades", el usuario verá un botón que lleva a la página de la oportunidad en el CRM.

Obtener información sobre una oportunidad individual

Para obtener información sobre una oportunidad específica, realiza una solicitud:

 GET https://api.wazzup24.com/v3/deals/{deal id}
Respuesta

Los datos se devolverán en forma de un objeto con los siguientes parámetros:

Parámetro Tipo  Descripción
id Number ID de la oportunidad. Campo obligatorio, no más de 100 caracteres.
responsibleUserId String ID del usuario responsable. Necesario para mostrar el diálogo con un contacto relacionado al usuario responsable en los chats de Wazzup.
name String Nombre de la oportunidad, no más de 200 caracteres.
uri string Enlace a la oportunidad en el CRM. Si se especifica, en el menú desplegable "Oportunidades", el usuario podrá ver una lista de oportunidades con ese contacto y acceder a su página en el CRM. Campo opcional, no más de 200 caracteres.
contacts Object Arreglo con los ID de los contactos relacionados a la oportunidad. Los ID pueden ser cadenas de texto.
closed Boolean Indicador que marca si la oportunidad está cerrada.

Eliminar una oportunidad

Para eliminar una oportunidad específica, realiza la solicitud:

 DELETE https://api.wazzup24.com/v3/deals/{deal id}

Ejemplo de solicitud

 curl --location --request DELETE 'https://api.wazzup24.com/v3/deals/101' \

--header 'Authorization: Bearer c8cf97644023482f909520d454368d27'

Errores

  • Errores comunes para todas las rutas:
  • 404 Not Found – Si la oportunidad no existe.

Eliminación de múltiples oportunidades

Para eliminar varias oportunidades a la vez, realiza la solicitud:

 PATCH https://api.wazzup24.com/v3/deals/bulk_delete

En el cuerpo de la solicitud se debe pasar un arreglo con los ID de las oportunidades a eliminar. Si la eliminación es exitosa, se devolverá 200 OK y un arreglo vacío. Si algunas de las oportunidades especificadas no existen en Wazzup, sus ID se devolverán en el arreglo de la respuesta.