POST
/
cms
/
entities
/
v1

Authorizations

Authorization
string
headerrequired

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

Body

application/json
project_id
string
required
type_id
string

The type id of the entity. For example competition. May be set to default when no custom fields are present.

name
string
description
string
thumbnail_asset_id
string
disabled
boolean
fields
object
visibility
enum<string>
Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN
localized_name
object

A map of localized names for this entity, for end users to see. The key is the language code (ISO 639 - set 1) (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2) e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the name field.

localized_description
object

A map of localized descriptions for this entity. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the description field.

localized_thumbnail_asset_id
object

A map of localized thumbnail asset IDs for this entity. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the thumbnail_asset_id field.

Response

200 - application/json
entity
object

Entity represents some object, such as competition, conference, team or person.

List entitiesUpdate entity