Activate or Deactivate Media

This endpoint allows activating or deactivating a media file in the system by its UUID. It is restricted to users with BACKOFFICE authority.

Authorization

Requires a valid JWT token with BACKOFFICE authority:

Authorization: Bearer {{YOUR-ACCESS-TOKEN}}

HTTP Method & Endpoint

PUT /api/media/{MEDIA-UUID}/active/{active}
  • uuid: The unique identifier of the media to update.

  • active: Boolean (true or false) to activate or deactivate the media.

Example cURL

curl --location --request PUT '{{BASE-URL}}/api/media/{{MEDIA-UUID}}/active/{{ACTIVE}}' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}'

Path Parameters

Parameter
Type
Required

MEDIA-UUID

String

Yes

ACTIVE

Boolean

Yes

Response

HTTP 204 No Content

The request was successful. No response body is returned.

Notes

  • This action does not delete the media. It simply changes its active status.

  • The endpoint is idempotent: calling it multiple times with the same values has no side effects.

  • You can only access this endpoint if your account has BACKOFFICE privileges.

Params that should be replaced:

BASE-URL:

YOUR-ACCESS-TOKEN:

Access token provided by the endpoint mentioned on this documentation: Generate an API Token

MEDIA-UUID: UUID of the media to be updated

MEDIA-UUID: True to activate, false to deactivate

Last updated