Skip to main content
POST
Generate or toggle public sharing link for wrapped report

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Path Parameters

year
integer
required

Year to share wrapped data for

Example:

2024

Body

application/json
disable
boolean

Set to true to revoke sharing

Example:

false

Response

Sharing enabled or disabled successfully

shared
boolean
Example:

true

url
string | null
Example:

"https://app.gratona.com/wrapped/2024/abc123-uuid"

token
string | null
Example:

"abc123-uuid"

shared_at
string<date-time> | null
message
string
Example:

"Sharing enabled successfully"