Rarely ResourcesResources

Social Videos

Read social videos and manage native video metadata and product or collection links.

GET
/api/integrations/v1/social-videos
List social videos
Returns merchant social videos with product or collection links.
POST
/api/integrations/v1/social-videos
Create social video
Creates a native social video.
PATCH
/api/integrations/v1/social-videos/:videoId
Update social video
Updates a native social video. Connected social videos are read-only.
GET
/api/integrations/v1/social-videos
Read social videos
List social videos
Use this endpoint to read social video metadata and linked catalog entities.
Query Parameters
Supported inputs for this operation.
limit
integerOptional
Maximum rows per page.
Default: 50
cursor
stringOptional
Opaque cursor from a previous page.
Examples
Switch between the sample request and example responses for this endpoint.
Sample cURL
curl -X GET "https://merchants.rarely.co/api/integrations/v1/social-videos" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST
/api/integrations/v1/social-videos
Write social videos
Create social video
Use this endpoint to add native social video metadata and link it to one product or one collection.
Request Body
JSON payload fields accepted by this endpoint.
title
stringOptional
Video title.
caption
stringOptional
Video caption.
video_asset_id
uuidOptional
Merchant media asset for the video.
video_url
stringOptional
External video URL.
thumbnail_asset_id
uuidOptional
Merchant media asset for the thumbnail.
product_ids
uuid[]Optional
Single product id to link.
collection_ids
uuid[]Optional
Single collection id to link.
submit
booleanOptional
Submit the social video for review immediately. Requires social_videos.submit.
Examples
Switch between the sample request and example responses for this endpoint.
Sample cURL
curl -X POST "https://merchants.rarely.co/api/integrations/v1/social-videos" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Packing the backpack",
  "product_ids": [
    "91dcd85d-8b1d-4f9f-90f0-694f9a604c74"
  ]
}'
PATCH
/api/integrations/v1/social-videos/:videoId
Write social videos
Update social video
Use this endpoint for partial updates to Rarely-native social videos. Connected social videos return a conflict instead of being changed.
Path Parameters
Supported inputs for this operation.
videoId
uuidRequired
Social video id.
Example: f08c8fed-bf44-48c1-9bd4-2ab701aac102
Request Body
JSON payload fields accepted by this endpoint.
title
stringOptional
New pending title.
caption
stringOptional
New pending caption.
product_ids
uuid[]Optional
Single product id to keep linked.
collection_ids
uuid[]Optional
Single collection id to keep linked.
Examples
Switch between the sample request and example responses for this endpoint.
Sample cURL
curl -X PATCH "https://merchants.rarely.co/api/integrations/v1/social-videos/:videoId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Packing the backpack"
}'
Live PlaygroundClient memory only
Test live requests against your merchant integration API.
The docs app proxies requests server-side to the merchant API. Your API key stays in local browser memory for the current docs session and is never stored by this UI.
Resolved request
https://merchants.rarely.co/api/integrations/v1/social-videos
Live Output
Switch between the generated request and the most recent live response.
Generated cURL
curl -X GET "https://merchants.rarely.co/api/integrations/v1/social-videos" \
  -H "Authorization: Bearer YOUR_API_KEY"

Search docs

Search guides, endpoints, scopes, and parameters.