Conversations
Add conversation channels
Adds the given channels to the conversation, keeping the ones it already has, and returns the conversation.
POST
Adds the given channels to the conversation, keeping the ones it already has, and returns the conversation.
apiKeyheader
x-api-key<token>id*stringMatch
^conv_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
channels*array<>Items
1 <= itemsConversation
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.addChannels({ "id": "example", "channels": [ "sms" ]});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"}