Assign prompt template

Assign a published prompt template version to a workspace channel.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <API_KEY>, where API_KEY is your API key.

Path parameters

workspaceIdstringRequired
Workspace to configure.
modestringRequired

Channel to configure. Allowed values: chat or voice. The template type must match this value.

Headers

X-Account-IdstringRequired
Account that owns the workspace.

Request

This endpoint expects an object.
versionIdstringRequiredformat: "uuid"
Published template version to assign. It must belong to your partner and match the channel.
variablesobjectOptional

The variable values, keyed by variable key. Validated against the version variable definitions: required variables must be present (unless they have a default), values must match the declared type, and unknown keys are rejected.

Response

The template assignment for this channel.
promptTemplateobject

The active assignment on this slot — the same object the workspace detail inlines as chat.promptTemplate / voice.promptTemplate.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error