Passer au contenu principal
PATCH
Update a follow-up type

Autorisations

Authorization
string
header
requis

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Paramètres de chemin

id
string
requis

Corps

application/json

On update, only the fields given change; overrides, when given, replaces them all.

name
string

Required on creation

Maximum string length: 255
description
string | null
color
string | null
Exemple:

"#22c55e"

delay_minutes
integer
Plage requise: x >= 1
Exemple:

60

interval_minutes
integer
Plage requise: x >= 1
Exemple:

1440

max_follow_ups
integer
Plage requise: 1 <= x <= 10
Exemple:

2

active
boolean
overrides
object[]

Réponse

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Exemple:

true

code
integer
Exemple:

1000

message
string
Exemple:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false