Update video with the Vimeo API

Updates the title, description, privacy or license of a video of the connected user and returns it. Fields left out keep their value. Some privacy options, like password and team, depend on the plan of the account.

Identifier
vimeo_update_video

The request

POST https://connect.reportei.com/api/tools/vimeo_update_video/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "video_id": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
video_idintegerYesId of the video: the number at the end of its uri in List videos, or the first number after vimeo.com/ in the URL of the video.
namestringNoNew title of the video, up to 128 characters.
descriptionstringNoNew description of the video, up to 5000 characters.
privacyobjectNoWho can watch, embed, comment on and download the video. Only the fields sent change.
passwordstringNoPassword of the video, up to 32 characters. Required when privacy.view is password.
licensestringNoCreative Commons license of the video.Values: by, by-nc, by-nc-nd, by-nc-sa, by-nd, by-sa, cc0

Supported connections

Your customer connects their Vimeo account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/vimeo, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/vimeo_update_video. It becomes your agent's tool definition with no conversion.

Other Vimeo tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.