Embed Presets

Assign an embed preset to a video

PUT https://api.vimeo.com/videos/{video_id}/presets/{preset_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

The embed preset was assigned.

Create a new custom logo

POST https://api.vimeo.com/me/customlogos Playground
POST https://api.vimeo.com/users/{user_id}/customlogos Playground
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
201 Created

The custom logo was created.

403 Forbidden

You cannot upload pictures for another user's videos.

403 Forbidden

The user cannot add a custom logo.

Create a new video custom logo

POST https://api.vimeo.com/videos/{video_id}/timelinethumbnails
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
201 Created

404 Not Found

If video was not found.

403 Forbidden

If the user is attempting to upload pictures for another user's videos.

Edit a user's embed preset

PATCH https://api.vimeo.com/me/presets/{preset_id} Playground
PATCH https://api.vimeo.com/users/{user_id}/presets/{preset_id} Playground
Name Type Required Description
outro enum
  • nothing
No

Disable the outro.

HTTP Status Code Explanation
200 OK

The embed preset was edited.

404 Not Found

The preset does not exist.

404 Not Found

The authenticated user does not own the preset.

400 Bad Request

The outro type is invalid.

Get a user's custom logo

GET https://api.vimeo.com/me/customlogos/{logo_id} Playground
GET https://api.vimeo.com/users/{user_id}/customlogos/{logo_id} Playground
HTTP Status Code Explanation
200 OK

The custom logo was returned.

403 Forbidden

The user cannot view custom logos.

Get a user's embed preset

GET https://api.vimeo.com/me/presets/{preset_id} Playground
GET https://api.vimeo.com/users/{user_id}/presets/{preset_id} Playground
HTTP Status Code Explanation
200 OK

The embed preset was returned.

Get a video's custom logo

Check if a user has a custom logo.

GET https://api.vimeo.com/videos/{video_id}/timelinethumbnails/{thumbnail_id}
HTTP Status Code Explanation
200 OK

403 Forbidden

If the user is not permitted to view this custom logo.

Get all a user's custom logos

GET https://api.vimeo.com/me/customlogos Playground
GET https://api.vimeo.com/users/{user_id}/customlogos Playground
HTTP Status Code Explanation
200 OK

The custom logos were returned.

403 Forbidden

The user cannot view this custom logo.

403 Forbidden

The user cannot view custom logos.

Get all embed presets for a video

Check if a video has a specific embed preset.

GET https://api.vimeo.com/videos/{video_id}/presets/{preset_id} Playground
HTTP Status Code Explanation
204 No Content

The embed presets were returned.

404 Not Found

If preset was not found.

404 Not Found

If video was not found.

Get all embed presets that a user has created

GET https://api.vimeo.com/me/presets Playground
GET https://api.vimeo.com/users/{user_id}/presets Playground
Name Type Required Description
page integer No

The page number to show.

per_page integer No

The number of items to show on each page (maximum 100).

HTTP Status Code Explanation
200 OK

The embed presets were returned.

Get all videos with a user's embed preset

GET https://api.vimeo.com/me/presets/{preset_id}/videos Playground
GET https://api.vimeo.com/users/{user_id}/presets/{preset_id}/videos Playground
Name Type Required Description
page integer No

The page number to show.

per_page integer No

The number of items to show on each page (maximum 100).

HTTP Status Code Explanation
200 OK

The videos were returned.

Unassign an embed preset from a video

DELETE https://api.vimeo.com/videos/{video_id}/presets/{preset_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

The embed preset was unassigned.

404 Not Found

If preset was not found.

404 Not Found

If video was not found.

Send Feedback