Skip to main content
DELETE
/
pictoryapis
/
v1
/
vimeo-connections
/
{connectionid}
Delete Vimeo Connection
curl --request DELETE \
  --url https://api.pictory.ai/pictoryapis/v1/vimeo-connections/{connectionid} \
  --header 'Authorization: <authorization>'
No content returned. The connection has been successfully deleted.

Documentation Index

Fetch the complete documentation index at: https://docs.pictory.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Permanently delete a Vimeo connection and all its associated configuration data. This action cannot be undone. After deletion, any integrations or workflows using this connection will no longer function. Only the connection owner can delete it.
Permanent Action: Deleting a connection is irreversible. Ensure you no longer need this connection before proceeding. Consider disabling it instead if you might need it again later.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.

​
API Endpoint

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

​
Request Parameters

​
Headers

​
Authorization
string
required
API key for authentication (starts with pictai_)
Authorization: YOUR_API_KEY

​
Path Parameters

​
connectionid
string
required
The unique identifier of the Vimeo connection to deleteExample: "20251222155613307xv0nodhitf9cd0f"

​
Response

Returns HTTP 204 (No Content) on successful deletion. The response body is empty as the connection no longer exists. This endpoint is idempotent - deleting an already-deleted or non-existent connection also returns 204. If authentication fails, an error response is returned with details.

​
Response Examples

No content returned. The connection has been successfully deleted.

​
Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_
# Delete a Vimeo connection
# Replace YOUR_API_KEY with your actual API key
# Replace CONNECTION_ID with the actual connection ID

curl --request DELETE \
  --url https://api.pictory.ai/pictoryapis/v1/vimeo-connections/CONNECTION_ID \
  --header 'Authorization: YOUR_API_KEY' | python -m json.tool

​
Error Handling

Cause: Invalid or missing API keySolution:
  • Verify your API key is correct and starts with pictai_
  • Check the Authorization header is properly formatted: YOUR_API_KEY
  • Ensure your API key hasn’t expired
  • Get a new API key from the API Access page
Behavior: This endpoint is idempotent and always returns 204 (No Content) on successWhat This Means:
  • Deleting an already-deleted connection returns 204 (success)
  • Deleting a non-existent connection returns 204 (success)
  • Multiple delete requests for the same connection are safe
  • You can delete without checking if the connection exists first
  • This follows REST API best practices for DELETE operations

​
Best Practices

​
Before Deleting a Connection

  1. Verify Dependencies: Check if any active workflows or integrations are using this connection
  2. Export Configuration: Note down the connection settings if you might need to recreate it later
  3. Consider Disabling: If you are unsure, use the Update Vimeo Connection endpoint to set enabled: false instead of deleting
  4. Confirm Identity: Double-check the connection ID to ensure you are deleting the correct connection
Idempotent Operation: This endpoint is safe to call multiple times. If you are unsure whether a connection exists, you can simply delete it without checking first - the operation will succeed either way.

​
Alternative to Deletion

Instead of permanently deleting a connection, you can disable it: 
PUT /v1/vimeo-connections/{connectionid}
{
  "enabled": false,
  "version": 1
}
Disabling preserves all configuration data while preventing the connection from being used. You can re-enable it later if needed.

​
Safe Deletion Workflow

// Example: Safe deletion workflow with confirmation
const safeDeleteConnection = async (apiKey, connectionId) => {
  // Step 1: Get connection details
  const connection = await getVimeoConnectionById(apiKey, connectionId);
  console.log(`About to delete: ${connection.name}`);

  // Step 2: Confirm (in production, get user confirmation)
  const confirmed = true; // Replace with actual confirmation logic

  if (!confirmed) {
    return { cancelled: true };
  }

  // Step 3: Delete the connection
  await deleteVimeoConnection(apiKey, connectionId);
  console.log('Connection deleted successfully');

  return { success: true };
};
Impact on Videos: Deleting a Vimeo connection does not affect videos that were previously uploaded using this connection. Those videos remain in your Vimeo account. However, you will not be able to upload new videos through this connection.