CanvasesUpdate canvas

Update canvas

Partially update canvas metadata.

curl -X PATCH "https://api.mythic-analytics.com/api/v1/canvases/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "John Doe",
  "description": "example_string",
  "settings": {}
}'
{
  "success": true,
  "data": {
    "id": "cvs_5kN2mPqR",
    "name": "User Journey Flow",
    "description": "example_string",
    "status": "draft",
    "settings": {},
    "current_version": "ver_2nK8mPqR",
    "created_at": "2024-04-20T08:00:00.000Z",
    "updated_at": "2024-06-12T14:20:00.000Z"
  }
}
PATCH
/canvases/{id}
PATCH
Bearer Token
Bearer Tokenstring
Required

Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY

Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
API Key (query: admin_key)
admin_keystring
Required

Alternative to the Authorization header for server-to-server scenarios.

Alternative to the Authorization header for server-to-server scenarios.
path
idstring
Required

Canvas identifier.

Content-Typestring
Required

The media type of the request body

Options: application/json
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY

query
admin_keystring
Required

API Key for authentication. Alternative to the Authorization header for server-to-server scenarios.

Path Parameters

idstring
Required

Canvas identifier.

Responses

successboolean
dataobject