CanvasesSave canvas

Save canvas

Save the current canvas state as a working draft. This creates a snapshot that can be reverted to later.

curl -X POST "https://api.mythic-analytics.com/api/v1/canvases/example_string/save" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ]
}'
{
  "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"
  }
}
POST
/canvases/{id}/save
POST
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
nodesarray
Required

Array of canvas node objects.

edgesarray
Required

Array of canvas edge objects.

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.

Body

application/json
nodesarray
Required

Array of canvas node objects.

edgesarray
Required

Array of canvas edge objects.

Responses

successboolean
dataobject