Canned Messages for Tenant

Returns all canned messages for tenant

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Responses

200

OK

Numberinteger · int32Required

Canned message number

Messagestring · min: 1Required

The text of the canned message

LastUpdatedstring · date-timeOptional

A date and time that the entry was last modified

get/V2/{tenantVarCode}/cannedmessages

GET /V2/{tenantVarCode}/cannedmessages HTTP/1.1
Accept: */*

200

OK

[
  {
    "Number": 1,
    "Message": "text",
    "LastUpdated": "2026-01-01T00:00:00.000Z"
  }
]

Returns specified canned message for tenant

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

cannedMessageNumberinteger · int32Required

Canned Message Number

Responses

200

OK

Numberinteger · int32Required

Canned message number

Messagestring · min: 1Required

The text of the canned message

LastUpdatedstring · date-timeOptional

A date and time that the entry was last modified

get/V2/{tenantVarCode}/cannedmessages/{cannedMessageNumber}

GET /V2/{tenantVarCode}/cannedmessages/{cannedMessageNumber} HTTP/1.1
Accept: */*

200

OK

{
  "Number": 1,
  "Message": "text",
  "LastUpdated": "2026-01-01T00:00:00.000Z"
}

Updates canned message for tenant

put

Path parameters

tenantVarCodestringRequired

Tenant Var Code

cannedMessageNumberinteger · int32Required

Canned Message Number

Body

Numberinteger · int32Required

Canned message number

Messagestring · min: 1Required

The text of the canned message

LastUpdatedstring · date-timeOptional

A date and time that the entry was last modified

Responses

200

OK

No content

put/V2/{tenantVarCode}/cannedmessages/{cannedMessageNumber}

PUT /V2/{tenantVarCode}/cannedmessages/{cannedMessageNumber} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "Number": 1,
  "Message": "text",
  "LastUpdated": "2026-01-01T00:00:00.000Z"
}

200

OK

No content