Skip to main content
POST
Create a tracked 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 an opaque member token. The credential alone identifies the member and company.

Body

application/json

What to share, how, and to whom.

target
object
required

What to share.

channel
enum<string>

Where the member is sharing it (default link).

Available options:
link,
email,
sms,
whatsapp,
facebook,
x,
qr
recipient
object

One of the member's contacts.

Response

The existing share for this target, channel and recipient.

One share.

status
integer
required

HTTP response status.

data
object
required

A tracked link the member created.

meta
object
required

Envelope metadata present on every response.