<aside> ❗ Importante: con fecha 2024-06-28 se movió la funcionalidad de subir archivos a un nuevo endpoint Subir archivo a un Deal . Este endpoint “Crear Deal” ahora recibe únicamente un body JSON con los fields dentro de una llave fields.

</aside>

Descripción

Crea un deal en un flow. Los parámetros exactos que espera la creación de un deal dependen del flow en particular para el que se quiere crear y se pueden obtener de Obtener información de un Flow.

Este endpoint acepta body únicamente en formato application/json y no acepta la subida de archivos. Si se quieren subir archivos debe utilizarse el endpoint Subir archivo a un Deal .

Todas las variables que se quieran rellenar de una tarjeta deben ir como llaves individuales de un objeto con llave fields y soportan recibir un valor directo (ej: center: 1) o un objeto con un value y un label ({ value, label }) de la siguiente forma:

{
	value: any;      // Depende del field
	label: string;
}

El CRM guardará como valor del field el campo value, pero mostrará en la interfaz el valor del campo label (ej: center: { value: 1, label: "Clínica 1" }).

Para las variables tipo select, se debe mandar obligatoriamente su valor como el objeto { value, label } descrito anteriormente.

Ruta

crm/integration-generic/deals

Método

POST

Autorización

Este endpoint requiere autorización según se indica en Authorization

Parámetros de entrada (body application/json)

Nombre del dato Tipo Dato Descripción Requerido
flowId string (UUID) UUID del flow donde se quiere crear el deal
statusId integer Id del estado en que se creará el deal dentro del flow. La lista de estados posibles se puede obtener de Obtener información de un Flow
assignee string (UUID) UUID de usuario al que se le asignará el deal. La lista de usuarios válidos se puede obtener de ‣. No
fields `{
[key: string]:
string |
number |
field

}` | Cada una de las variables del deal que se quiere rellenar.

Objeto field

Nombre del dato Tipo Dato Descripción
value string Valor real de la variable en CRM
label string Valor mostrado en la interfaz de CRM para la variable

Ejemplo objeto de entrada