Patients

Get conversations by patient ID

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

Query parameters

limitintegerOptional

Limit of items

Default: 10Example: 10

lastObjectIdstringOptional

ID of the last object

Example: abc123

pageNumberintegerOptional

Page number

Default: 1Example: 1

pageSizeintegerOptional

Size of the page

Default: 20Example: 20

statusanyOptional

Status of the conversation

Default: CLOSEExample: CLOSE

Responses

200Success

application/json

get

/api/conversations/patients/{patientId}

HTTPcURLJavaScriptPython

GET /api/conversations/patients/{patientId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "12345",
    "hostId": "host123",
    "targetId": "target123",
    "medium": "CHAT",
    "token": "token123",
    "subTitle": "Subtitle example",
    "title": "Title example",
    "profilePic": "http://example.com/profile.jpg",
    "status": "active",
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-02T00:00:00Z",
    "lastMessageAt": "2023-01-03T00:00:00Z",
    "lastMessage": {
      "text": "Hello"
    }
  }
]

Create a new conversation for a patient

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

targetIdstringRequired

The ID of the target

Example: 12345

initialMessagestringOptional

The initial message of the conversation

Example: Hello, how are you?

subjectstringOptional

The subject of the conversation

Example: Meeting Agenda

statusstring · enumOptional

The status of the conversation

Default: CLOSEExample: CLOSEPossible values:

Responses

200Success

application/json

post

/api/conversations/patients/{patientId}

HTTPcURLJavaScriptPython

POST /api/conversations/patients/{patientId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "targetId": "12345",
  "initialMessage": "Hello, how are you?",
  "subject": "Meeting Agenda",
  "status": "CLOSE"
}

200Success

{
  "id": "12345",
  "hostId": "host123",
  "targetId": "target123",
  "medium": "CHAT",
  "token": "token123",
  "subTitle": "Subtitle example",
  "title": "Title example",
  "profilePic": "http://example.com/profile.jpg",
  "status": "active",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "lastMessageAt": "2023-01-03T00:00:00Z",
  "lastMessage": {
    "text": "Hello"
  }
}

Update an existing conversation

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

conversationIdstringRequiredPattern: [^\/#\?]+?

patientIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

targetIdstringRequired

The ID of the target

Example: 12345

initialMessagestringOptional

The initial message of the conversation

Example: Hello, how are you?

subjectstringOptional

The subject of the conversation

Example: Meeting Agenda

statusstring · enumOptional

The status of the conversation

Default: CLOSEExample: CLOSEPossible values:

Responses

200Success

application/json

put

/api/conversations/{conversationId}/patients/{patientId}

HTTPcURLJavaScriptPython

PUT /api/conversations/{conversationId}/patients/{patientId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "targetId": "12345",
  "initialMessage": "Hello, how are you?",
  "subject": "Meeting Agenda",
  "status": "CLOSE"
}

200Success

{
  "id": "12345",
  "hostId": "host123",
  "targetId": "target123",
  "medium": "CHAT",
  "token": "token123",
  "subTitle": "Subtitle example",
  "title": "Title example",
  "profilePic": "http://example.com/profile.jpg",
  "status": "active",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "lastMessageAt": "2023-01-03T00:00:00Z",
  "lastMessage": {
    "text": "Hello"
  }
}