---
title: "Create a player"
method: POST
path: "/v2/sites/{site_id}/players/"
tags: ["players"]
---

# Create a player

`POST /v2/sites/{site_id}/players/`

Create a player

## Path parameters

- `site_id` string, required — Unique identifier for a resource

## Request body

- object
  - `metadata` PlayerMetadata
    - `name` string — User-generated name used to uniquely identify a player A maximum of 10000 characters is permitted.
    - `setup_config` object — Set of [features, behaviors, and options](https://docs.jwplayer.com/jwplayer/docs/jw8-player-configuration-reference#setup-options) used to instantiate a player
    - `release_channel` 'latest' | 'biannual' | 'downgrade' | 'preview' | 'previous' — Defines the [release channel](https://docs.jwplayer.com/jwplayer/docs/jw8-use-jw-player-release-channels) to which the player is set Release channels offer different speeds of automatically updating player versions. Default: `latest`
    - `custom_params` CustomParamSchema — User-generated key-value pairs When defining `custom_params`, include all custom parameters that should be associated with the target resource. When updating existing `custom_params`, include all `custom_params` keys with their updated values. Any `custom_params` key-value pair not included within the updated `custom_params` in the request body is [deleted](https://docs.jwplayer.com/platform/docs/stream-faq-how-can-i-delete-a-custom-parameter).
  - `relationships` object
    - `recommendations_playlist` RelationshipWrite
      - `id` string, required — Unique identifier for a resource
    - `adschedule` RelationshipWrite
      - `id` string, required — Unique identifier for a resource

## Response `201`

Resource successfully created

- PlayerResourceRead
  - `schema` string
  - `id` string — Unique identifier for a resource
  - `created` string — Date and time at which the resource was created
  - `last_modified` string — Date and time at which the resource was most recently modified
  - `type` string — Name of the type of resource.
  - `relationships` object — Ancilliary resources associated to the primary resource being read
    - `recommendations_playlist` RelationshipRead
      - `id` string — Unique identifier for a resource
      - `type` string — Resource type
    - `adschedule` RelationshipRead
      - `id` string — Unique identifier for a resource
      - `type` string — Resource type
  - `metadata` PlayerMetadata
    - `name` string — User-generated name used to uniquely identify a player A maximum of 10000 characters is permitted.
    - `setup_config` object — Set of [features, behaviors, and options](https://docs.jwplayer.com/jwplayer/docs/jw8-player-configuration-reference#setup-options) used to instantiate a player
    - `release_channel` 'latest' | 'biannual' | 'downgrade' | 'preview' | 'previous' — Defines the [release channel](https://docs.jwplayer.com/jwplayer/docs/jw8-use-jw-player-release-channels) to which the player is set Release channels offer different speeds of automatically updating player versions. Default: `latest`
    - `custom_params` CustomParamSchema — User-generated key-value pairs When defining `custom_params`, include all custom parameters that should be associated with the target resource. When updating existing `custom_params`, include all `custom_params` keys with their updated values. Any `custom_params` key-value pair not included within the updated `custom_params` in the request body is [deleted](https://docs.jwplayer.com/platform/docs/stream-faq-how-can-i-delete-a-custom-parameter).
  - `version` '8' — Major version associated with the player

## Other responses

- `400` — Bad Request The request either lacks certain attributes or contains malformed/invalid attributes.

---

[API](https://skmtc.net/jwplayer/apis/management-api-v2.md) · [All operations](https://skmtc.net/jwplayer/apis/management-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jwplayer/management-api-v2/versions/180db7cada27/schema)