Skip to content
Livstick Developers
v3 Request access

Schemas

API v3.1

V31Container

Name Type Required Description
crid string Required
urid string Required
mode V31ContainerMode Required single holds one message (gift message); gallery accepts several (savings pot). Required at creation and immutable afterwards. Values single gallery
state V31ContainerState Required Values recording_open recording_closed
shipped boolean Required
shippedAt string | null Required Constraints format date-time
notifiedAt string | null Required Constraints format date-time
notifications V31Notifications Required
gallery V31Gallery | null Required null for a single container.
links V31ContainerLinks Optional
createdAt string Required Constraints format date-time
updatedAt string Required Constraints format date-time

V31ContainerLinks

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

V31ContainerList

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

V31ContainerMode

single holds one message (gift message); gallery accepts several (savings pot). Required at creation and immutable afterwards.

Type string

Values single gallery

V31ContainerState

Type string

Values recording_open recording_closed

V31CreateContainerRequest No additional properties accepted

Name Type Required Description
crid string Required Constraints pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$
mode V31ContainerMode Required single holds one message (gift message); gallery accepts several (savings pot). Required at creation and immutable afterwards. Values single gallery
language string Optional uid of a platform language.
codeGroup string Optional publicId of a code group of the platform; ignored when unknown.
sender V31Sender Optional
recipient V31Recipient Optional
gallery V31GalleryInput Optional
notifications V31Notifications Optional
additionalData object Optional At most 20 keys matching ^[A-Za-z0-9_]{1,40}$; values are strings (500 characters at most), numbers or booleans. Key names containing mail or phone are refused.

V31CreateContainerResponse

Name Type Required Description
crid string Required
urid string Required
mode V31ContainerMode Required single holds one message (gift message); gallery accepts several (savings pot). Required at creation and immutable afterwards. Values single gallery
state V31ContainerState Required Values recording_open recording_closed
editKey string Required Key of the first message. Returned at creation and replay only, never by a read.
notifications V31Notifications Required
links V31ContainerLinks Required
platformId string Required
createdAt string Required Constraints format date-time

V31Error No additional properties accepted

Name Type Required Description
code string Required
message string Required

V31ErrorEnvelope No additional properties accepted

Name Type Required Description
error V31Error Required

V31Gallery

Name Type Required Description
title string | null Required
messageCount integer Required
listedCount integer Required Messages publicly listed.
closed boolean Required

V31GalleryInput No additional properties accepted

Name Type Required Description
title string Optional Constraints max length 80

V31Health

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

V31Message

Message view. thumbnailUrl, videoUrl, data and content are present only when the platform messageAccess is admin; videoUrl and thumbnailUrl only in state published.

Name Type Required Description
messageId string Required
mrid string | null Required
role V31MessageRole Required Values organizer contributor
state V31MessageState Required Values rejected held failed processing hidden pending_review published
held boolean Required
durationMs integer | null Required
revision integer Required
createdAt string Required Constraints format date-time
updatedAt string Required Constraints format date-time
releasedAt string | null Required Constraints format date-time
viewedAt string | null Required Constraints format date-time
thumbnailUrl string Optional Constraints format uri
videoUrl string Optional Constraints format uri
data object Optional
data.firstname string Optional
data.lastname string Optional
data.relation string Optional
content string Optional

V31MessageList

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

V31MessageRole

Type string

Values organizer contributor

V31MessageState

Type string

Values rejected held failed processing hidden pending_review published

V31Notifications No additional properties accepted

Name Type Required Description
organizer V31NotifyChoice Optional Who sends the e-mails of an audience: livstick (default), client (your platform sends its own) or none. Values livstick client none
contributors V31NotifyChoice Optional Who sends the e-mails of an audience: livstick (default), client (your platform sends its own) or none. Values livstick client none
recipient V31NotifyChoice Optional Who sends the e-mails of an audience: livstick (default), client (your platform sends its own) or none. Values livstick client none

V31NotifyChoice

Who sends the e-mails of an audience: livstick (default), client (your platform sends its own) or none.

Type string

Values livstick client none

V31NotifyRequest No additional properties accepted

Name Type Required Description
recipient object Optional
recipient.firstName string Optional Constraints max length 50
recipient.email string Optional Constraints max length 254, format email

V31NotifyResponse

Name Type Required Description
result string Required Constraints always ok
notifiedAt string Required Constraints format date-time
emailQueued boolean Required true when the recipient notification is livstick and an address is present.

V31Recipient No additional properties accepted

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

V31RecordTokenRequest No additional properties accepted

Name Type Required Description
mrid string Required Constraints pattern ^[A-Za-z0-9:_-]{1,64}$
role V31MessageRole Optional Values organizer contributor
hold boolean Optional Encode the video but wait for release before publishing it. Default false
sender object Optional
sender.firstName string Optional Constraints max length 50
sender.lastName string Optional Constraints max length 50
expiresIn integer Optional Lifetime in seconds. Default 3600 Constraints min 60, max 86400

V31RecordTokenResponse

Name Type Required Description
recordToken string Required
urid string Required
mrid string Required
role V31MessageRole Required Values organizer contributor
hold boolean Required
expiresAt string Required Constraints format date-time

V31Sender No additional properties accepted

Name Type Required Description
firstName string Optional Constraints max length 50
lastName string Optional Constraints max length 50
email string Optional Constraints max length 254, format email

V31UnlockResponse

Name Type Required Description
result string Required Constraints always ok
shipped boolean Required
shippedAt string Required Constraints format date-time

V31UpdateContainerRequest No additional properties accepted

Name Type Required Description
shipmentCarrier string Optional
shipmentCode string Optional Constraints max length 100
newcrid string Optional Constraints pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$
language string Optional
sender V31Sender Optional
recipient V31Recipient Optional
notifications V31Notifications Optional
gallery V31GalleryInput Optional

V31ViewTokenRequest No additional properties accepted

Name Type Required Description
scope string Required Values viewer owner
mrid string Optional Optional; must exist. Constraints pattern ^[A-Za-z0-9:_-]{1,64}$
expiresIn integer Optional Lifetime in seconds. Default 900 Constraints min 60, max 3600

V31ViewTokenResponse

Name Type Required Description
viewToken string Required
scope string Required Values viewer owner
mrid string | null Required
expiresAt string Required Constraints format date-time

V31WebhookDelivery

Name Type Required Description
deliveryId string Required
eventId string Required
eventType string Required
endpointId string Required
crid string | null Optional
mrid string | null Optional
state string Required Values pending done failed skipped
attempts integer Required
lastStatus integer | null Optional
nextAttemptAt string | null Optional Constraints format date-time
createdAt string Required Constraints format date-time
updatedAt string Required Constraints format date-time

V31WebhookDeliveryList

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