Skip to content
Livstick Developers
v3 Request access

Schemas

API v3

ApiError No additional properties accepted

Name Type Required Description
code string Required
message string Required

ApiErrorEnvelope No additional properties accepted

Name Type Required Description
error ApiError Required

CodeGroupListItem

Name Type Required Description
objectId string Required
name string Required
publicId string Optional
status integer Required
createdAt string Required Constraints format date-time

CodeGroupListResponse

Name Type Required Description
items array of CodeGroupListItem Required
total integer Required
limit integer Required
skip integer Required

ContainerDetails No additional properties accepted

Name Type Required Description
crid string Required
urid string Required
state ContainerState Required Values recording_open recording_closed
mode ContainerMode Required Values single gallery
shipped boolean Optional
message MessageInfo Optional

ContainerLinks No additional properties accepted

Name Type Required Description
recordingUrl string Required Constraints format uri
previewUrl string Required Constraints format uri

ContainerListItem No additional properties accepted

Name Type Required Description
objectId string Required Unique container identifier.
crid string Required Business reference of the container.
urid string Optional Short recording identifier.
state ContainerState Required Values recording_open recording_closed
shipped boolean Required
createdAt string Required Constraints format date-time
message ContainerListMessageInfo Optional

ContainerListMessageInfo No additional properties accepted

Name Type Required Description
state MessageState Required Values pending_release released delivery_triggered unknown
videoUrl string Optional Constraints format uri

ContainerListResponse No additional properties accepted

Name Type Required Description
items array of ContainerListItem Required
total integer Required
limit integer Required
skip integer Required

ContainerMode

Type string

Values single gallery

ContainerState

Type string

Values recording_open recording_closed

CreateContainerInput No additional properties accepted

Name Type Required Description
crid string Required
emailDeprecated string Optional Deprecated alias of sender.email. Constraints format email
sender SenderInput Optional Optional sender identity and contact values.
recipient RecipientInput Optional Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.
language string Optional
codeGroup string Optional
mode ContainerMode Optional Container mode. single (default) holds one message; gallery accepts multiple messages. Ignored when the container already exists. Values single gallery
additionalData object Optional Arbitrary metadata, preserved unchanged. Historical contact aliases remain recognized: email, senderEmail, sender first/last-name variants, receiverEmail, receiverPhone, and messageNotified.

CreateContainerOutput No additional properties accepted

Name Type Required Description
crid string Required
urid string Required
state ContainerState Required Values recording_open recording_closed
mode ContainerMode Required Values single gallery
editKey string Optional Edit key returned only on container creation.
links ContainerLinks Required

HealthStatus

Name Type Required Description
status string Required Constraints always ok
service string Required Constraints always client-api-v3

MessageDetailResponse

Name Type Required Description
objectId string Required
state MessageState Required Values pending_release released delivery_triggered unknown
type integer Required
createdAt string Required Constraints format date-time
updatedAt string Optional Constraints format date-time
crid string Optional
urid string Optional
codeGroupId string Optional
videoUrl string Optional Constraints format uri
thumbUrl string Optional Constraints format uri
redeemCode string Optional Canonical redeem code normalized from message private data.
data object Optional
privateData object Optional
analysisData object Optional
language string Optional
scheduledAt string Optional Constraints format date-time
activatedAt string Optional Constraints format date-time
viewedAt string Optional Constraints format date-time

MessageInfo No additional properties accepted

Name Type Required Description
state MessageState Required Values pending_release released delivery_triggered unknown
videoUrl string Optional Constraints format uri
data object Optional

MessageListItem

Name Type Required Description
objectId string Required Unique message identifier (use for GET/PATCH /messages/{messageId}).
state MessageState Required Values pending_release released delivery_triggered unknown
type integer Required
createdAt string Required Constraints format date-time
crid string Optional Business reference of the parent container.
urid string Optional Short recording identifier.
codeGroupId string Optional ObjectId of the code group (if assigned).
videoUrl string Optional Constraints format uri
thumbUrl string Optional Constraints format uri
redeemCode string Optional Canonical redeem code normalized from message private data.
data object Optional
privateData object Optional Private data (not visible to end users).
analysisData object Optional Analysis results (read-only).
language string Optional Language UID (e.g. fr, en_us).

MessageListResponse

Name Type Required Description
items array of MessageListItem Required
total integer Required
limit integer Required
skip integer Required

MessageState

Type string

Values pending_release released delivery_triggered unknown

NotifyContainerInput No additional properties accepted

Optional contact overrides applied immediately before delivery.

Name Type Required Description
sender SenderInput Optional Optional sender identity and contact values.
recipient RecipientInput Optional Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

OperationResult No additional properties accepted

Name Type Required Description
result string Required Constraints always ok

RecipientInput No additional properties accepted

Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

Name Type Required Description
firstName string Optional
lastName string Optional
email string Optional Constraints format email
phone string Optional International E.164 phone number. Constraints pattern ^\+[1-9][0-9]{7,14}$
channel string Optional Values email sms

SenderInput No additional properties accepted

Optional sender identity and contact values.

Name Type Required Description
firstName string Optional
lastName string Optional
email string Optional Constraints format email

UpdateContainerInput No additional properties accepted

Name Type Required Description
shipmentCarrier string Optional Values chronopost ups coursier dhl other
shipmentCode string Optional
newcrid string Optional
language string Optional
emailDeprecated string Optional Deprecated alias of sender.email. Constraints format email
sender SenderInput Optional Optional sender identity and contact values.
recipient RecipientInput Optional Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

UpdateMessageDataInput

Name Type Required Description
data object Optional Merge into message.data (keys overwrite, others preserved).
privateData object Optional Merge into message.privateData (validated against schema if defined).