Skip to navigation
API ReferenceTransfers

Update a transfer destination

The kind cannot change. Sending config replaces the whole settings object.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

idstringRequiredformat: "uuid"
Destination ID

Request

This endpoint expects an object.
configobject or nullOptional

Replaces the whole kind-specific settings object.

enabledboolean or nullOptional
namestring or nullOptional

Response

Destination updated
configobject
createdAtdatetime
enabledboolean
idstringformat: "uuid"
kindstring

Destination kind: phone, available_humans (the people who are available for calls in the dashboard), or app (your own server)

namestring
updatedAtdatetime
previousSecretExpiresAtdatetime or nullOptional

App destinations, after a rotation: until this time webhooks are also signed with the previous secret (a second v1= in Talkif-Signature)

signingSecretstring or nullOptional

App destinations: the secret that signs the webhooks. Returned only when the destination is created or its secret rotated; store it, it is not shown again

signingSecretHintstring or nullOptional

App destinations: the last characters of the signing secret, to tell secrets apart

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error