Skip to content

Refresh a staff theme key

POST/v2/staff-theme-key/refresh

POST
/v2/staff-theme-key/refresh
curl --request POST \
--url https://api.ligr.live/rest/v2/staff-theme-key/refresh \
--header 'Authorization: Bearer <token>'

Beta. This operation can change between minor versions. See Beta status.

Gives the calling staff theme key one more hour, never past 12 hours after it was made. An expired key cannot call this: refresh it on the admin Themes page of the dashboard.

Ok

Media typeapplication/json
object
expiresAt
required

ISO time the key stops working unless it is refreshed again.

string
refreshableUntil
required

ISO time after which no refresh works. Make a new key on the dashboard then.

string
Examplegenerated
{
"expiresAt": "example",
"refreshableUntil": "example"
}

The key reached its 12-hour limit

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
"message": "example",
"details": {
"additionalProperty": "example"
}
}

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

Only a staff theme key refreshes itself

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

Organization has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}