POST /api/v2/publishing_channels/:publishing_channel_id/share
Share to publishing channel

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
share_params required	Parameters for sharing Validations: Must be a Hash

Examples

// Successful request
POST /api/v2/publishing_channels/3/share
{
  "share_params": {
    "assetId": "5PxQ0o09AKMnNArmE6xH",
    "filename": "qprRc3wBx_jIS9u7SRcE_publish.mp4",
    "s3_key": "media/qprRc3wBx_jIS9u7SRcE/qprRc3wBx_jIS9u7SRcE_publish.mp4",
    "title": "small.mp4",
    "description": "small.mp4",
    "tags": []
  }
}
200
{
  "ok": "ok"
}

// When trying to share media type the channel does not support
POST /api/v2/publishing_channels/4/share
{
  "share_params": {
    "assetId": "GkCgAnxobt5gKGFzeqR4",
    "filename": "qprRc3wBx_jIS9u7SRcE_publish.mp4",
    "s3_key": "media/qprRc3wBx_jIS9u7SRcE/qprRc3wBx_jIS9u7SRcE_publish.mp4",
    "title": "small.mp4",
    "description": "small.mp4",
    "tags": []
  }
}
422
{
  "error": "Media type must be [\"audio\", \"video\", \"image\", \"other\"] for this channel type"
}

// Publishing channel does not exist
POST /api/v2/publishing_channels/1337/share
{
  "share_params": {
    "assetId": "EJA9N_Y_cK3gbwRNIhmi",
    "filename": "qprRc3wBx_jIS9u7SRcE_publish.mp4",
    "s3_key": "media/qprRc3wBx_jIS9u7SRcE/qprRc3wBx_jIS9u7SRcE_publish.mp4",
    "title": "small.mp4",
    "description": "small.mp4",
    "tags": []
  }
}
404
{
  "error": "Publishing channel not found"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters