BEbeyondwords
Access tiers

Create access tier

Changed on

Creates an access tier for a project to control player access to content.

post/projects/{project_id}/player_settings/access_tiers

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/player_settings/access_tiers
  • Auth
    API key in header X-Api-Key

Request body

slugstring required
namestring required
segment_limitinteger nullable
ads_enabledboolean
intro_urlstring nullable
outro_urlstring nullable
cta_textstring nullable
cta_urlstring nullable

Response

Created

idinteger
slugstring

Unique identifier for the object

namestring

Human readable name of the access tier

segment_limitinteger nullable

Maximum number of segments allowed for playback. Null means no limit.

ads_enabledboolean

Whether ads are enabled for this tier

intro_urlstring nullable

URL of the intro audio file

outro_urlstring nullable

URL of the outro audio file

cta_textstring nullable

Text of the call-to-action shown in the player

cta_urlstring nullable

URL the call-to-action links to

createdstring

Time at which the object was created (ISO 8601)

updatedstring

Time at which the object was updated (ISO 8601)

Changes

  • 994b9853e685Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status