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.

Listado en la app web
  • RED

  • ORANGE

  • YELLOW

  • GREEN

  • BLUE

  • PINK

  • BLACK

Listado de minutos disponibles.

Listado en la app web
  • 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)

triangle-exclamation

Ejemplo de request

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

body

circle-info

date: Si bien la fecha esta representada en UTC, hay que considerarla en horario local. Entonces para el caso del ejemplo, y sin importar si soy un cliente de Argentina, Ecuardor o Mexico, la fecha del evento representa el día 1 de Febrero de 2023 hora de mi país

Analizando la Respuesta

En caso que no haya ningun error, obtenemos

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.

circle-info

Si bien la fecha esta representada en UTC, hay que considerarla en horario local. Entonces para el caso del ejemplo, y sin importar si soy un cliente de Argentina, Ecuardor o Mexico, la fecha mostrada representa el día 1 de Febrero de 2023 hora de mi país

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.

triangle-exclamation

Last updated