Skip to main content
POST
Create a follow-up type

Authorizations

Authorization
string
header
required

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

Body

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
Example:

"#22c55e"

delay_minutes
integer
Required range: x >= 1
Example:

60

interval_minutes
integer
Required range: x >= 1
Example:

1440

max_follow_ups
integer
Required range: 1 <= x <= 10
Example:

2

active
boolean
overrides
object[]

Response

200 - application/json

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

success
boolean
Example:

true

code
integer
Example:

1000

message
string
Example:

"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