OPopenintake
Texts

Update Text Thread

Changed on

Archive or unarchive a thread. A new inbound message reopens an archived one.

patch/texts/threads/{thread_id}

Request

  • Base URL
    https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.openintake.ai/texts/threads/{thread_id}
  • Auth
    none declared

Path parameters

thread_idstring uuid required

Request body

status'open' | 'archived' required

Response

Successful Response

text_thread_idstring uuid required
contact_phonestring required
business_phonestring required
contact_namestring nullable

The linked outbound lead's name, else the thread's display name

outbound_lead_idstring uuid nullable
lead_idstring uuid nullable
statusstring required
last_message_atstring date-time nullable
last_message_previewstring nullable
last_message_directionstring nullable
last_inbound_atstring date-time nullable
is_unreadboolean required
needs_staffboolean

The SMS agent handed this person to staff and no one at the firm has texted them or marked it handled since

needs_staff_sincestring date-time nullable

When the SMS agent handed the thread to staff, while it still needs them

needs_staff_reasonstring nullable

Why the SMS agent handed the thread to staff, in the firm's words

message_countinteger required
is_testboolean required
created_atstring date-time required

Changes

  • 4d3da2f87786Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2874401d2b40Revision changes
    • info

      endpoint added