Skip to content

/v1/labels/{id}/publish

POST
/v1/labels/{id}/publish
curl --request POST \
--url https://example.com/v1/labels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish \
--header 'Authorization: Bearer <token>'

Publish a label through the server-side Action. Idempotent: an already-published label returns its existing short URL.

id
required
string format: uuid

Publish result with the e-label short URL

Media typeapplication/json
object
short_url
required
string
<= 2000 characters
short_url_marketing
required
string | null
<= 2000 characters
failed_formats
required
Array<object> | null
object
format_id
required
string format: uuid
reason
required
string
<= 2000 characters
Examplegenerated
{
"short_url": "example",
"short_url_marketing": "example",
"failed_formats": [
{
"format_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"reason": "example"
}
]
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Workspace cannot publish (plan or quota)

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Not a member of the workspace

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Label not found

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}