Sign in
latestSwagger 2.02026-08-1095121164.0 KB

94758829689e

sites

Create Site Workflow

Creates a new site-level workflow.

post/v0/sites/{site_id}/workflows

Path parameters

site_idstring required

Site UUID

Request body

paramsobject

Workflow parameters (varies by workflow type)

typestring required

Workflow type (e.g., add_site_user_membership, remove_site_user_membership)

Example request

{
  "type": "add_site_user_membership"
}

Response

active_descriptionstring

Active description of current workflow step

created_atnumber double

Creation timestamp

idstring required

Workflow ID

number_of_tasksinteger

Number of tasks in the workflow

typestring

Workflow type

Example response

{
  "active_description": "Starting workflow",
  "created_at": 1234567890,
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "number_of_tasks": 5,
  "type": "add_site_user_membership"
}