Skip to main content
POST
/
media
/
{uuid}
/
grant
Grant a consumer access to a media item
curl --request POST \
  --url https://api.example.com/media/{uuid}/grant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>' \
  --data '
{
  "consumerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "spin_the_wheel_reward",
  "sourceRef": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
'
{
  "entitlementId": "f1e2d3c4-b5a6-9870-fedc-ba0987654321",
  "status": "granted"
}
Required scope
  • write:media — Upload, modify, and manage media files and content assets. Also required for vault folder management.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

​
X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

​
uuid
string<uuid>
required

Body

application/json
​
consumerId
string<uuid>
required

UUID of the consumer to grant media access to

​
source
string
required

Identifier for the granting application or reason (e.g. spin_the_wheel_reward)

Required string length: 1 - 100
Pattern: ^[a-z0-9_]+$
Example:

"spin_the_wheel_reward"

​
sourceRef
string
required

Unique identifier within the source, used for idempotency (e.g. spin attempt UUID)

Required string length: 1 - 255
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Media access granted (or already existed)

​
entitlementId
string<uuid>
required

UUID of the created or existing entitlement

​
status
enum<string>
required
Available options:
granted