Assign a contact to a turn
/turns/{id}Authorization
bearerAuth Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.
In: header
Path Parameters
uuidHeader Parameters
Send 1 to pin the documented API contract. If omitted, the latest version is selected.
"1"Value in
- "1"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/turns/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-API-Version: 1" \ -H "Content-Type: application/json" \ -d '{ "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "scope": "turn" }'{ "success": true, "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "started_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z", "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81", "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352", "speaker_id": "ecc2b943-041b-423f-959a-a650358728fd", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "detected_contact_id": "7ffb5336-f522-4744-97d9-0d22757b8632", "contact_source": "detected", "override_enabled": true, "override_contact_id": "85c6d8a2-ad73-42d2-9055-26aac001ecb9", "clock_uncertainty_ms": 0, "content": { "schema_version": 1, "text": "string", "words": [ { "text": "string", "start_ms": 0, "end_ms": 0 } ] }, "audio": { "state": "string", "removed_at": "2019-08-24T14:15:22Z" } }}