Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Slugs can be created to generate a better looking URL for your pages, leading to better SEO and user experience. For example, for an entity page that requires two variables, instead of using https://example.com/en-US/entity/competition/HiKTtRZYdyGU/2024 you can define a slug for https://example.com/en-US/la-liga-2024. The slug would be /la-liga-2024 and the path would be /entity/competition/HiKTtRZYdyGU/2024 (excluding the language segment, including the leading slash).

slug
string
required

The slug for a page. This cannot contain any / characters, other than as the first character.

project_id
string
required
path
string
required

The path to the page that this slug is for. This includes all segments except the language segment. An example path might be /entity/competition/HiKTtRZYdyGU/2024

platform_id
string

The platform ID that this slug belongs to.

is_canonical
boolean

If set to true, all other slugs for this path will 301 redirect to this slug. There can only be one canonical slug per path.

visibility
enum<string>
Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN

Response

OK

slug
object

Slugs can be created to generate a better looking URL for your pages, leading to better SEO and user experience. For example, for an entity page that requires two variables, instead of using https://example.com/en-US/entity/competition/HiKTtRZYdyGU/2024 you can define a slug for https://example.com/en-US/la-liga-2024. The slug would be /la-liga-2024 and the path would be /entity/competition/HiKTtRZYdyGU/2024 (excluding the language segment, including the leading slash).