Crear seguimientos

Para crear un seguimiento se debe realizar un POST como el que se muestra a continuación.

POST https://api.persat.com.ar/v1/follow_ups

Headers

Name

Type

Description

Content-Type*

string

application/json

Authorization*

string

Bearer API_KEY

Request Body

Name

Type

Description

uid_client*

string

El número/identificador de cliente (es un valor alfanumérico).

title*

string

Título del seguimiento.

responsible_user_ids*

number[]

Listado de ids de usuarios responsables del seguimiento. Mínimo 1 responsable.

color*

string

Color identificador del seguimiento. Ver colores disponibles en la siguiente sección.

date*

string

Fecha del seguimiento en formato ISO, debe ser una fecha futura. Ejemplo: 2021-09-09T14:30:00.000Z.

description

string

Descripción del seguimiento.

send_email_minutes_before

number

Minutos previos a la fecha en los que se envía un email a los responsables. Ver minutos disponibles en la siguiente sección. Si no está presente no se envía mail.

Aclaraciones sobre el request

Listado de colores disponibles.

RED
ORANGE
YELLOW
GREEN
BLUE
PINK
BLACK

Listado de minutos disponibles.

0 (en el momento del seguimiento)
10
20
30
45
60 (1 hora)
120 (2 horas)
180 (3 horas)
240 (4 horas)
300 (5 horas)
1440 (1 día)
2880 (2 días)
4320 (3 días)
5760 (4 días)
10080 (1 semana)

{
    "success": true,
    "data": {
        "id": 33,
        "uid_client": "CL-0044",
        "title": "Llamar",
        "description": "",
        "color": "RED",
        "responsible_user_ids": [
            1,
            2,
            3
        ],
        "send_email": false,
        "date": "2026-01-01T00:00:00.000Z"
    }
}

{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "'uid_client' debe ser un string"
    }
}

{
    "success": false,
    "error": {
        "status": 409,
        "type": "CONFLICT",
        "userMessage": "No existe el cliente con uid: 'CL-0044'"
    }
}

{
    "success": false,
    "error": {
        "status": 409,
        "type": "CONFLICT",
        "userMessage": "Los usuarios con id 1,2. No tienen permitido ver el cliente"
    }
}

Ejemplo de request

En este ejemplo insertamos un seguimiento, que incluye envío de email 2 horas antes de la fecha del seguimiento.

body

{
    "title": "Llamar",
    "description": "Realizar nota de pedido",
    "uid_client": "CL-0044",
    "color": "ORANGE",
    "date": "2030-02-01T20:00:00.000Z",
    "responsible_user_ids": [1,2,52],
    "send_email_minutes_before": 120 
}

Analizando la Respuesta

En caso que no haya ningun error, obtenemos

{
    "success": true,
    "data": {
        "id": 35,
        "uid_client": "CL-0044",
        "title": "Llamar",
        "description": "Realizar nota de pedido",
        "color": "ORANGE",
        "responsible_user_ids": [
            1,
            2,
            52
        ],
        "date": "2030-02-01T20:00:00.000Z",
        "send_email_minutes_before": 120,
        "send_email": true
    }
}

id: Identificador del seguimiento.

uid_client: identificador alfanumérico del cliente.

title: título del seguimiento.

description: descripción del seguimiento.

color: color del seguimiento.

responsible_user_ids: ids de los usuarios responsables del seguimiento.

date: fecha del seguimiento.

send_email: booleano que indica si se enviará email

send_email_minutes_before: los minutos previos a la fecha en los que se va a enviar un mail a los responsables en forma de aviso del seguimiento. En este ejemplo se enviaría el 2030-02-01T18:00:00.000Z.

send_email_minutes_before solo estará presente cuando send_email sea 'true'

Last updated 3 months ago

{ "success": true, "data": { "id": 33, "uid_client": "CL-0044", "title": "Llamar", "description": "", "color": "RED", "responsible_user_ids": [ 1, 2, 3 ], "send_email": false, "date": "2026-01-01T00:00:00.000Z" } }

{ "title": "Llamar", "description": "Realizar nota de pedido", "uid_client": "CL-0044", "color": "ORANGE", "date": "2030-02-01T20:00:00.000Z", "responsible_user_ids": [1,2,52], "send_email_minutes_before": 120 }

{ "success": true, "data": { "id": 35, "uid_client": "CL-0044", "title": "Llamar", "description": "Realizar nota de pedido", "color": "ORANGE", "responsible_user_ids": [ 1, 2, 52 ], "date": "2030-02-01T20:00:00.000Z", "send_email_minutes_before": 120, "send_email": true } }