Update an existing Vimeo connection

put

https://api.pictory.ai/pictoryapis/v1/vimeo-connections/{connectionid}

Updates the configuration of an existing Vimeo connection. You can update the connection name, description, enabled status, and authentication credentials. The version number must be provided to prevent concurrent modification conflicts. If updating the connection name, it must remain unique within your account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

connectionid

string

required

The unique identifier of the Vimeo connection to update

Body Params

Request payload for updating an existing Vimeo connection. At least one field besides version must be provided to update the connection.

name

string

length ≤ 100

^[a-zA-Z0-9 _-]*$

The updated display name of the Vimeo connection. If changed, the new name must be unique within your account. Maximum 100 characters. Can only contain letters, numbers, spaces, underscores, and hyphens.

description

string

length ≤ 250

An updated detailed description of the Vimeo connection. Maximum 250 characters.

enabled

boolean

Updated status indicating whether the connection should be active. Set to true to enable the connection, false to disable it. Disabling a connection prevents it from being used but retains all configuration.

clientIdentifier

string

length ≤ 500

Updated Vimeo application client identifier (Client ID). Use this to change which Vimeo application the connection uses for authentication.

clientSecret

string

length ≤ 500

Updated Vimeo application client secret. Use this to rotate or update the client secret credential. Keep this value secure.

accessToken

string

length ≤ 500

Updated Vimeo access token. Use this to refresh or change the access token used for API authentication. This might be necessary if the token expires or if you need to change the permissions scope.

version

integer

required

The current version number of the connection. This must match the version number of the connection in the database to prevent conflicts from concurrent updates. If the version doesn't match, the update will fail with a 400 error.

Headers

Authorization

string

required

Authentication token for authorization. This token is used to verify the user's identity and ensure they have permission to modify the connection.

Responses

400

Bad request. The request failed validation. Common reasons include: missing required version field, invalid field formats, field values exceeding maximum length, the version number doesn't match the current version (indicating the connection was modified by another request), a connection with the new name already exists, or invalid characters in the name field.

401

Unauthorized access. The request failed because the authentication token is invalid, missing, or expired.

404

Vimeo connection not found. Either the connection doesn't exist, has been deleted, or the authenticated user doesn't have permission to access it.

500

Internal server error occurred while processing the request.

200Vimeo connection updated successfully. The response contains the updated connection details.