Embed Presets

Add a 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.

Add a new custom logo to a video

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.

Add 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.

Check if an embed preset has been added to a video

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

The embed presets exists.

404 Not Found

If preset was not found.

404 Not Found

If video was not found.

Edit an 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 custom video logo

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

The custom logo was returned.

403 Forbidden

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

Get a specific 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 specific 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 all the custom logos that belong to a user

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 the 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 the videos that have been added to an 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.

Remove 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