Runtype APIMessaging Conversations

Update conversation

Update a messaging conversation by ID.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.
contextobjectOptional
participantEmailstringOptionalformat: "email"<=255 characters
participantMetadatamap from strings to anyOptional
participantNamestringOptional<=255 characters
statusenumOptional
Allowed values:
subjectstringOptional<=500 characters
timezonestring or nullOptional<=64 characters

Response

Updated conversation
agentModestring
createdAtstring
externalParticipantIdstring or null
externalThreadIdstring or null
idstring
lastMessageAtstring or null
messageCountdouble
participantEmailstring or null
participantNamestring or null
statusstring
subjectstring or null
surfaceIdstring
takeoverActorIdstring or null
takeoverActorTypestring or null
takeoverAtstring or null
takeoverReasonstring or null
timezonestring or null
updatedAtstring
contextmap from strings to any
participantMetadatamap from strings to any
surfaceobject

Errors

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