Skip to main content

Snippets

Tags: content, snippets

Endpoints

List

GET /api/v2/w/{workspace_uuid}/snippets

Description:

Reusable content snippets and macros

List all snippets for the workspace.

Authorization: Requires workflows:read scope

Response: List of SnippetResponse


Create

POST /api/v2/w/{workspace_uuid}/snippets

Description:

Reusable content snippets and macros

Create a new snippet.

Authorization: Requires workflows:write scope

Parameters:

Response: See SnippetResponse


Delete Snippet Id

DELETE /api/v2/w/{workspace_uuid}/snippets/{snippet_id}

Description:

Reusable content snippets and macros

Delete a snippet. Returns usage info for any templates referencing it.

Authorization: Requires workflows:write scope

Parameters:

  • snippet_id (Integer)

Response: See dict


Get Snippet Id

GET /api/v2/w/{workspace_uuid}/snippets/{snippet_id}

Description:

Reusable content snippets and macros

Get a specific snippet by ID.

Authorization: Requires workflows:read scope

Parameters:

  • snippet_id (Integer)

Response: See SnippetResponse


Update Snippet Id

PUT /api/v2/w/{workspace_uuid}/snippets/{snippet_id}

Description:

Reusable content snippets and macros

Update an existing snippet.

Authorization: Requires workflows:write scope

Parameters:

Response: See SnippetResponse