Workflow automation

Get all workflows

get

Retrieves all workflows

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters
requestTypestring · enumOptional

Type of the request

Example: REQUEST_TYPE_EXAMPLEPossible values:
typestring · enumOptional

Type of workflow

Example: AUTOMATEDPossible values:
activebooleanOptional

Whether the workflow is active

Default: trueExample: true
sortFieldstringOptional

Sort field

Example: name
sortOrderstring · enumOptional

Sort order

Example: ASCPossible values:
pageNumberinteger · min: 1Optional

Page number

Example: 1
pageSizeinteger · min: 1Optional

Page size

Example: 10
searchKeystringOptional

Search key

Example: search
Responses
200Success
application/json
get
/api/workflow-automation
200Success

Create workflow

post

Creates a new workflow

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body
titlestringRequired

External ID for the workflow

Example: external-123
requestTypestring · enumRequired

Type of the request

Example: REQUEST_TYPE_EXAMPLEPossible values:
typestring · enumRequired

Type of workflow

Example: AUTOMATEDPossible values:
attributesanyOptional

Additional attributes in JSON format

externalIdstringOptional

External ID for the workflow

Example: external-123
statusstring · enumOptional

Status of the workflow

Example: ACTIVEPossible values:
Responses
200Success
application/json
Responseany
post
/api/workflow-automation
200Success

No content

Get workflow by ID

get

Retrieves a specific workflow

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
workflowIdnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
Responseany
get
/api/workflow-automation/{workflowId}
200Success

No content

Update workflow

put

Updates an existing workflow

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
workflowIdnumberRequiredPattern: [^\/#\?]+?
Body
titlestringOptional

External ID for the workflow

Example: external-123
requestTypestring · enumOptional

Type of the request

Example: REQUEST_TYPE_EXAMPLEPossible values:
typestring · enumOptional

Type of workflow

Example: AUTOMATEDPossible values:
attributesanyOptional

Additional attributes in JSON format

externalIdstringOptional

External ID for the workflow

Example: external-123
statusstring · enumOptional

Status of the workflow

Example: ACTIVEPossible values:
populationTagsinteger[]Optional

Population tags ids for the workflow

populationTagsToRemoveinteger[]Optional

Population tags ids to remove for the workflow

Responses
200Success
application/json
Responseany
put
/api/workflow-automation/{workflowId}
200Success

No content

Delete workflow

delete

Deletes an existing workflow

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
workflowIdnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
Responseany
delete
/api/workflow-automation/{workflowId}
200Success

No content