Passer au contenu principal
PATCH
Update a Shortext endpoint

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

"ste_xxx"

Corps

application/json
name
string

Required on creation

Maximum string length: 255
agent_id
string | null

Agent answering on the endpoint; null detaches it

Exemple:

"AGI-XXXXX"

enabled
boolean
défaut:true
reply_mode
enum<string>
défaut:async

async: replies pushed to webhook_url (signed); sync: replies in the response of the inbound call

Options disponibles:
async,
sync
sync_timeout
integer
défaut:25

Seconds the sync mode waits for the replies

Plage requise: 1 <= x <= 25
webhook_url
string | null

Where the replies are pushed (https); null removes it

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