Skip to main content
POST
Schedule one explicitly selected share

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Body

application/json
client_request_id
string<uuid>
required

Client-generated UUID retained for safe retries.

share_id
string<uuid>
required

Public UUID of an owned currently shareable link.

conversation_id
string<uuid>
required

Public UUID of a currently authorized conversation.

text
string
required

Optional user message, followed by the authoritative tracked share URL.

Maximum string length: 10000
scheduled_at
string<date-time>
required

Future delivery timestamp with an explicit offset.

Response

Saved for future delivery, not sent now.

Member API success envelope.

status
integer
required

HTTP status code.

Example:

201

data
object
required

Resource data.

meta
object
required

Resource meta.