Download OpenAPI specification:Download
Contains functionality around Workflows.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Gets the status of a workflow.
| workflowName required | string The name of the workflow. |
| workflowInstanceId required | string <uuid> The workflow instance ID to get the status for. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "data": null
}Gets the payload JSON schema of a workflow.
| workflowName required | string The name of the workflow. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
nullGet WorkflowEntityHistory for a given entity.
| entityType required | string (EntityType) Value: "Contact" Type of the Entity. |
| entityId required | string Id of the Entity. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "workflowEntityHistory": [
- {
- "workflowName": "string",
- "workflowInstanceId": "string",
- "status": "string",
- "startTime": "2024-11-07T14:53:55Z",
- "endTime": "2024-11-07T14:53:55Z",
- "data": null
}
]
}Updates a workflow.
| workflowName required | string The name of the workflow. |
| workflowInstanceId required | string <uuid> The workflow instance ID to update. |
| milestoneName required | string The name of the milestone. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request payload.
| payload required | any |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "payload": null
}{- "data": null
}Starts a workflow.
| workflowName required | string The name of the workflow. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request payload.
| payload required | any |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "payload": null
}{- "workflowInstanceId": "string",
- "data": null
}Queries data that is related to a workflow.
| workflowName required | string The name of the workflow. |
| queryName required | string The name of the query. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request payload.
| payload | any Nullable |
| workflowInstanceId | string <uuid> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "payload": null,
- "workflowInstanceId": "string"
}{- "data": null
}Create WorkflowEntity for a given entity.
| workflowInstanceId required | string <uuid> The workflowInstanceId of the workflow. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request payload.
| entityType | string (EntityType) Value: "Contact" |
| entityId | string Nullable |
| workflowName | string Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "entityType": "Contact",
- "entityId": "string",
- "workflowName": "string"
}{- "code": "General",
- "subCode": "string",
- "message": "string",
- "correlationId": "string",
- "properties": {
- "property1": null,
- "property2": null
}
}Complete a Workflow for a given entity.
| workflowName required | string Name of the workflow |
| workflowInstanceId required | string <uuid> The workflowInstanceId of the workflow. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request payload.
| status | string (WorkflowStatus) Enum: "Completed" "Abandoned" "Rejected" "Failed" |
| data | any Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "status": "Completed",
- "data": null
}{- "code": "General",
- "subCode": "string",
- "message": "string",
- "correlationId": "string",
- "properties": {
- "property1": null,
- "property2": null
}
}Get active WorkflowEntities
| entityType required | string (EntityType) Value: "Contact" Type of the Entity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
List of EntityIds
| entityIds | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "entityIds": [
- "string"
]
}{- "activeWorkflowEntities": [
- {
- "entityType": "string",
- "entityId": "string",
- "workflowName": "string",
- "startTime": "2024-11-07T14:53:55Z"
}
]
}Cancel a Workflow for a given workflowname and workflowInstanceId
| workflowName required | string Name of the workflow |
| workflowInstanceId required | string <uuid> The workflowInstanceId of the workflow |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request payload
| cancellationReason | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "cancellationReason": "string"
}{- "code": "General",
- "subCode": "string",
- "message": "string",
- "correlationId": "string",
- "properties": {
- "property1": null,
- "property2": null
}
}