Conversations
Update a conversation
Update a conversation. Updates the fields you name and keeps the rest. `metadata` merges into the stored metadata by key, and a `null` value deletes that key.
PATCH
Updates the fields you name and keeps the rest. metadata merges into the stored metadata by key, and a null value deletes that key. primaryChannel must be one of the conversation's channels. Tags, categories, and channels are not updated here: use POST and DELETE on /v1/conversations/{id}/tags, /v1/conversations/{id}/categories, and /v1/conversations/{id}/channels.
apiKeyheader
x-api-key<token>id*stringMatch
^conv_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
title?string|nulldescription?string|null|nullexternalId?string|null|nullparentConversationId?|null|nullprimaryChannel?|nullstatus?|nullstatusReason?string|null|nullpriority?|nullurgency?|nullcomplexity?|nullcontext?|null|nullmetadata?|nullisTest?boolean|nullisInternal?boolean|nullisPrivate?boolean|nullConversation
application/json- response
id*ConversationIdMatch
^conv_[0-9a-hjkmnp-tv-z]{16,24}$title*string|nullexternalId*string|nullstatus*stringValue in
"active""waiting""resolved""escalated""archived"primaryChannel*stringValue in
"sms""whatsapp""email"channels*array<>priority*integerRange
0 <= value <= 9007199254740991urgency*stringValue in
"low""medium""high""critical"tags*array<string>isTest*booleanmessageCount*integerRange
0 <= value <= 9007199254740991lastActivityAt*stringcreatedAt*stringdescription*string|nullparentConversationId*|nullstatusReason*string|nullcomplexity*stringValue in
"simple""moderate""complex"categories*array<string>metadata*|nullcontext*|nullisInternal*booleanisPrivate*booleancontacts*array<>startedAt*stringlastHumanActivityAt*string|nullresolvedAt*string|nullarchivedAt*string|nullresolutionType*|nullresolutionNotes*string|nullupdatedAt*stringimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.conversations.update({ "id": "example"});Example Response
{ "id": "string", "title": "string", "externalId": "string", "status": "active", "primaryChannel": "sms", "channels": [ "sms" ], "priority": 0, "urgency": "low", "tags": [ "string" ], "isTest": true, "messageCount": 0, "lastActivityAt": "string", "createdAt": "string", "description": "string", "parentConversationId": "string", "statusReason": "string", "complexity": "simple", "categories": [ "string" ], "metadata": { "property1": "string", "property2": "string" }, "context": { "customerData": { "property1": "string", "property2": "string" }, "previousConversations": [ "string" ], "sessionVariables": { "property1": "string", "property2": "string" }, "workflowState": { "currentStep": "string", "completedSteps": [ "string" ], "pendingSteps": [ "string" ], "workflowData": { "property1": "string", "property2": "string" } } }, "isInternal": true, "isPrivate": true, "contacts": [ { "id": "string", "name": "string", "displayName": "string", "identities": [ { "type": "email", "identifier": "string", "verified": true } ] } ], "startedAt": "string", "lastHumanActivityAt": "string", "resolvedAt": "string", "archivedAt": "string", "resolutionType": "automated", "resolutionNotes": "string", "updatedAt": "string"}