Conversations

Create a conversation

Creates a new conversation with its initial contacts and returns it with a 201 status.

post/v1/conversations

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/conversations
  • Auth: API key in header x-api-key

Request body

titlestring nullable
descriptionstring nullable
externalIdstring nullable
parentConversationIdstring
channelsstring[] required
primaryChannel'email' required
status'active' | 'waiting' | 'resolved' | 'escalated' | 'archived' nullable
statusReasonstring nullable
priorityinteger nullable
urgency'low' | 'medium' | 'high' | 'critical' nullable
complexity'simple' | 'moderate' | 'complex' nullable
metadataJsonObject
tagsstring[] nullable
categoriesstring[] nullable
isTestboolean nullable
isInternalboolean nullable
isPrivateboolean nullable

Response

Success

idstring required
titlestring nullable required
externalIdstring nullable required
status'active' | 'waiting' | 'resolved' | 'escalated' | 'archived' required
primaryChannel'email' required
channelsstring[] required
priorityinteger required
urgency'low' | 'medium' | 'high' | 'critical' required
tagsstring[] required
isTestboolean required
messageCountinteger required
lastActivityAtstring required
createdAtstring required
descriptionstring nullable required
parentConversationIdstring required
statusReasonstring nullable required
complexity'simple' | 'moderate' | 'complex' required
categoriesstring[] required
metadataJsonObject required
isInternalboolean required
isPrivateboolean required
startedAtstring required
lastHumanActivityAtstring nullable required
resolvedAtstring nullable required
archivedAtstring nullable required
resolutionType'automated' | 'human_assisted' | 'escalated' | 'abandoned' | 'timeout' nullable required
resolutionNotesstring nullable required
updatedAtstring required

Changes

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