Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

The TFU Live agent id, with its tfu_live: prefix, as GET /api/tfu-live-agents returns it. Other agent ids are refused.

Query Parameters

locationId
string
required

The sub-account. It must belong to the agency, and be the credential’s own sub-account when the credential is limited to one.

Body

application/json

Either { ifVersion, template } for a catalog template, or { ifVersion, workflow } for one you built. An id or tool on the workflow is ignored.

ifVersion
string
required

The agent’s ifVersion from your last read, such as GET /api/tfu-live-agents/{id}. If the agent changed since, the request is refused with 409.

Minimum string length: 1
template
string
required

A catalog template key. A template whose mustFill is not empty is refused until filled: copy it, fill it and send it as workflow.

Response

Successful TFU Live response. Setup acceptance is not verified readiness or campaign activation.

success
any
required
data
object
required