v11

OpenAPI 3.1.02026-08-0364112112.3 KB
Conversations

Create conversation

Creates conversation

post/v1/conversations

Request body

startedAtstring date-time nullable
subjectstring nullable
status'OPEN' | 'SNOOZED' | 'CLOSED' | 'PENDING'
customFieldsobject nullable
assignedTeamIdstring uuid nullable

Response

Successful Response

customerIdstring uuid required
startedAtstring date-time required
createdAtstring date-time required
closedAtstring date-time nullable
closedBystring uuid nullable
assignedAtstring date-time nullable
assignedBystring uuid nullable
browserstring nullable
operatingSystemstring nullable
numberinteger nullable
escalatedAtstring date-time nullable
subjectstring nullable
status'OPEN' | 'SNOOZED' | 'CLOSED' | 'PENDING'
priority'NO_PRIORITY' | 'LOW' | 'MEDIUM' | 'HIGH' | 'URGENT'
customFieldsobject nullable
snoozedUntilstring date-time nullable
assignedTeamIdstring uuid nullable
assignedToZeusboolean nullable
idstring uuid required
startedChannelstring nullable
startedSubChannelstring nullable

Example response

{
  "lastMessage": {
    "agent": {
      "profileUrl": "http://www.example.com/"
    }
  },
  "assignedAgent": {
    "profileUrl": "http://www.example.com/"
  }
}