COcounselhealth
/v1/user

Update a thread

Update fields on a thread

patch/v1/user/{userId}/threads/{threadId}/

Request

  • Base URL
    https://api.counselhealth.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

userIdstring required
threadIdstring uuid required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key. Repeat requests with the same key and body return the original result.

Request body

metadataobject

Custom key-value metadata for threads. Max 25 keys, each value ≤ 1800 characters. Keys must be alphanumeric with underscores/hyphens only.

Example request

{
  "metadata": {
    "external_session_id": "abc123",
    "plan": "pro",
    "linked_thread_title": "Lightheadedness when standing"
  }
}

Response

Default Response

idstring uuid required
patient_idstring uuid required
mode'AI' | 'PHYSICIAN' required
display_namestring nullable required
module'get_advice' | 'order_lab' | 'refill_medication' | 'review_my_results' | 'get_care' | 'lifestyle_conditions' | 'get_care_quickly' | 'symptom_radar' | 'review_lab_results' | 'bp_signals' | 'cycle_insights' | 'cycle_insights_ttc' | 'optimize_lifestyle' | 'get_treatment' nullable required

The chat module the thread is in. Nullable as chats started with a set of messages may have no module. May change over the life of the thread; a change emits thread.updated.

status'unclaimed' | 'assigned' | 'active' | 'closed' required
created_atstring date-time required
last_activity_timestring date-time required
expires_atstring date-time nullable required
updated_atstring date-time required
terminated_atstring date-time nullable required
termination_reason'emergency' | 'malicious_action' nullable required
sla_start_atstring date-time nullable
metadataobject nullable

Custom key-value metadata for threads. Max 25 keys, each value ≤ 1800 characters. Keys must be alphanumeric with underscores/hyphens only.

Example response

{
  "module": "get_care",
  "metadata": {
    "external_session_id": "abc123",
    "plan": "pro",
    "linked_thread_title": "Lightheadedness when standing"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.