Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

TFU Live agent id. Never use an ordinary provider agent id.

Query Parameters

locationId
string
required

Sub-account belonging to the authenticated agency and any narrower credential location binding.

Body

application/json

Exactly one orb shape. Any other key, a missing or extra preset or colors, an unknown preset, or anything but two #rrggbb colours is refused.

The colours of the agent’s orb, exactly one of four shapes. default: it follows the voice, purple and pink for a female voice, blue and cyan for a male one, indigo and mint for a voice that is neither; curated: colours derived from the agent id, the same on every screen; preset: one of 17 pairs from published palettes, each the palette’s first real colour as the main colour and the next colour that differs from it as the glow; custom: two colours of your own, the orb’s own colour then its glow. Cosmetic: it changes nothing the agent says or does.

style
any
required

Response

The orb colour now saved, as Get TFU Live agent returns it in orb.

success
any
required
data
object
required