Workflow Engine::Visual Workflows | Subrite

Workflow Engine::Visual Workflows

Endpoints for Workflow Engine::Visual Workflows

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/automation/visual-workflows

Authentication: Bearer token (JWT)

Parameters

Query parameters7

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"
orderBystringOptional
Default: "createdAt"Allowed values: "id", "name", "createdAt", "updatedAt", "publishedAt"
namestringOptional
Filter workflows by name (case-insensitive contains).
grouparray of stringOptional
Filter by one or more group label names.
isPublishedbooleanOptional
Filter by published state. true = Active, false = Draft.

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleVisualWorkflowPaginated

2 top-level fieldsSelect an object to expand

itemsarray of VisualWorkflowRequired19 fields
items
- namestringRequired when parent is presentField path: items[].name

Example requestcurl

curl

curl https://api.subrite.no/api/v1/automation/visual-workflows \
  --header 'Authorization: Bearer <token>'

Try it

Create a new visual workflow#

POST/api/v1/automation/visual-workflows

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateVisualWorkflowDto

7 top-level fields

namestringRequired
Workflow namemaxLength: 255
nodesarray of objectRequired
React Flow nodes

GET/api/v1/automation/visual-workflows/personalized-tokens

Authentication: Bearer token (JWT)

Parameters

Query parameters1

triggerTypestringOptional
Trigger type to resolve trigger-specific tokens formaxLength: 100

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

GET/api/v1/automation/visual-workflows/group-tags

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Group tags retrieved successfully

This response has no body.

Responses 401

GET/api/v1/automation/visual-workflows/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Visual workflow retrieved successfully

This response has no body.

PUT/api/v1/automation/visual-workflows/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateVisualWorkflowDto

7 top-level fields

namestringOptional
Workflow name:

DELETE/api/v1/automation/visual-workflows/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Visual workflow deleted successfully

PUT/api/v1/automation/visual-workflows/{id}/group-tag

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleSetWorkflowGroupTagDto

1 top-level field

tagNamestringRequired

Duplicate a visual workflow#

POST/api/v1/automation/visual-workflows/{id}/duplicate

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleDuplicateVisualWorkflowDto

1 top-level field

namestringRequired
Name for the duplicated workflow

Publish a visual workflow#

POST/api/v1/automation/visual-workflows/{id}/publish

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

8 status codes

Responses 200

Visual workflow published successfully

Unpublish a visual workflow#

POST/api/v1/automation/visual-workflows/{id}/unpublish

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

8 status codes

Responses 200

Visual workflow unpublished successfully

Send a test email for a workflow node#

POST/api/v1/automation/visual-workflows/{id}/test/email

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleWorkflowPreviewEmailDto

8 top-level fields

recipientsarray of string (email)Required

Send a test SMS for a workflow node#

POST/api/v1/automation/visual-workflows/{id}/test/sms

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleWorkflowPreviewSmsDto

6 top-level fields

phoneNumbersarray of stringRequired

updatedByUserUserRequired when parent is presentField path: items[].updatedByUser24 fields

items[].updatedByUser

userTypestringRequired when parent is presentField path: items[].updatedByUser.userType
Allowed values: "system_admin", "tenant_admin", "member", "not_set"
tenantIdnumberRequired when parent is presentField path: items[].updatedByUser.tenantId
emailstringRequired when parent is presentField path: items[].updatedByUser.email
Can be null
fullNamestringRequired when parent is presentField path: items[].updatedByUser.fullName
phonestringRequired when parent is presentField path: items[].updatedByUser.phone
emailVerifiedstringRequired when parent is presentField path: items[].updatedByUser.emailVerified
Can be null
phoneVerifiedbooleanRequired when parent is presentField path: items[].updatedByUser.phoneVerified
isOwnerbooleanRequired when parent is presentField path: items[].updatedByUser.isOwner
isTestUserbooleanRequired when parent is presentField path: items[].updatedByUser.isTestUser
imagestringRequired when parent is presentField path: items[].updatedByUser.image
createdInCheckoutUuidstringRequired when parent is presentField path: items[].updatedByUser.createdInCheckoutUuid
userRolesarray of UserRoleField path: items[].updatedByUser.userRolesNested fields omitted: depth limit.
notesarray of NoteRequired when parent is presentField path: items[].updatedByUser.notesNested fields omitted: depth limit.
exportHistoryarray of ExportHistoryRequired when parent is presentField path: items[].updatedByUser.exportHistoryNested fields omitted: depth limit.
userSettingsUserSettingsField path: items[].updatedByUser.userSettingsNested fields omitted: depth limit.
memberMemberField path: items[].updatedByUser.memberNested fields omitted: depth limit.
tenantTenantRequired when parent is presentField path: items[].updatedByUser.tenantNested fields omitted: depth limit.
userAccountsarray of UserAccountRequired when parent is presentField path: items[].updatedByUser.userAccountsNested fields omitted: depth limit.
userSessionsarray of UserSessionRequired when parent is presentField path: items[].updatedByUser.userSessionsNested fields omitted: depth limit.
idnumberRequired when parent is presentField path: items[].updatedByUser.id
createdAtstring (date-time)Required when parent is presentField path: items[].updatedByUser.createdAt
updatedAtstring (date-time)Required when parent is presentField path: items[].updatedByUser.updatedAt
deletedAtstring (date-time)Required when parent is presentField path: items[].updatedByUser.deletedAt
metaDataobjectRequired when parent is presentField path: items[].updatedByUser.metaData

Schema ExampleVisualWorkflowPaginated

200 · application/json

{
  "items": [
    {
      "nodes": {},
      "edges": {},
      "entityTags": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 18 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

edges

array of object

Schema ExampleCreateVisualWorkflowDto

application/json

{
  "name": "string",
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ],
  "description": "string",
  "isPublished": true,
  "isTemplate": false,
  "jsonLogic": {}
}

Example · 13 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Visual workflow created successfully

This response has no body.

Responses 400

Status201 400 401 403 500application/json

badRequest, workflowStructureInvalid

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "workflowStructureInvalid"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstring

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/automation/visual-workflows \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ],
  "description": "string",
  "isPublished": true,
  "isTemplate": false,
  "jsonLogic": {}
}'

Schema ExampleWorkflowTokensDto

200 · application/json

{
  "subscriptionInfo": [
    "string"
  ],
  "paymentInfo": [
    "string"
  ],
  "tokenSamples": {
    "property1": "string",
    "property2": "string"
  },
  "others": [
    "string"
  ],
  "memberInfo": [
    "string"
  ],
  "myPageLink": [
    "string"
  ]
}

Example · 21 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get personalized tokens for a workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

visualWorkflowNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "visualWorkflowNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

maxLength

255

Schema ExampleUpdateVisualWorkflowDto

application/json

{
  "name": "string",
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ],
  "description": "string",
  "isPublished": true,
  "isTemplate": true,
  "jsonLogic": {}
}

Example · 13 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Visual workflow updated successfully

This response has no body.

Responses 400

Status200 400 401 403 404 500application/json

badRequest, workflowStructureInvalid

Schema ExampleErrorResponse

Same fields as Create a new visual workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500application/json

visualWorkflowNotFound, jsonLogicRuleNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "visualWorkflowNotFound", "jsonLogicRuleNotFound"
messagestring

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/automation/visual-workflows/{id}' \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ],
  "description": "string",
  "isPublished": true,
  "isTemplate": true,
  "jsonLogic": {}
}'

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get personalized tokens for a workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

visualWorkflowNotFound, jsonLogicRuleNotFound

Schema ExampleErrorResponse

Same fields as Update an existing visual workflow (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Group tag updated successfully

This response has no body.

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get personalized tokens for a workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500application/json

visualWorkflowNotFound

Schema ExampleErrorResponse

Same fields as Get a visual workflow by ID (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/automation/visual-workflows/{id}/group-tag' \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tagName": "string"
}'

Responses

6 status codes

Responses 201

Visual workflow duplicated successfully

This response has no body.

Responses 400

Status201 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get personalized tokens for a workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 500application/json

visualWorkflowNotFound

Schema ExampleErrorResponse

Same fields as Get a visual workflow by ID (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/automation/visual-workflows/{id}/duplicate' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string"
}'

Responses 400

Status200 201 400 401 403 404 409 500application/json

badRequest, workflowStructureInvalid

Schema ExampleErrorResponse

Same fields as Create a new visual workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 201 400 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 201 400 401 403 404 409 500application/json

visualWorkflowNotFound

Schema ExampleErrorResponse

Same fields as Get a visual workflow by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 409

Status200 201 400 401 403 404 409 500application/json

workflowIsAlreadyPublished

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "workflowIsAlreadyPublished"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "workflowIsAlreadyPublished",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 201

Status200 201 400 401 403 404 409 500application/json

Schema ExampleVisualWorkflow

Same fields as Publish a visual workflow (201).

Schema ExampleVisualWorkflow

201 · application/json

{
  "name": "string",
  "nodes": {},
  "edges": {},
  "isPublished": true,
  "publishedAt": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "updatedByUser": {
    "userType": "system_admin",
    "tenantId": 0,
    "email": "string",
    "fullName": "<fullName>",
    "phone": "<phone>",
    "emailVerified": "string",
    "phoneVerified": true,
    "isOwner": true,
    "isTestUser": true,
    "image": "string",
    "createdInCheckoutUuid": "string",
    "userRoles": [],
    "notes": [],
    "exportHistory": [],
    "userSettings": {
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "userAccounts": [],
    "userSessions": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "description": "string",
  "isTemplate": true,
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "workflowRuleId": "string",
  "workflowRule": {
    "rule": {},
    "description": "string",
    "isActive": true,
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "visualWorkflow": {},
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "entityTags": [
    {
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 211 linesShow full heightShow compact view

Responses 400

Status200 201 400 401 403 404 409 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get personalized tokens for a workflow (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 201 400 401 403 404 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all visual workflows (paginated) (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 201 400 401 403 404 409 500application/json

visualWorkflowNotFound

Schema ExampleErrorResponse

Same fields as Get a visual workflow by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 409

Status200 201 400 401 403 404 409 500application/json

workflowIsNotPublished

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "workflowIsNotPublished"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "workflowIsNotPublished",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleWorkflowPreviewEmailDto

application/json

{
  "recipients": [
    "user@example.com",
    "test@example.com"
  ],
  "subject": "Welcome to our platform!",
  "emailContent": [
    {
      "type": "paragraph",
      "children": [
        {
          "text": "Thank you for joining us!"
        }
      ]
    }
  ],
  "emailPreviewText": "Get started with your account",
  "name": "Welcome Email Template",
  "senderId": 1,
  "templateId": 2,
  "automationId": 123
}

Example · 22 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/automation/visual-workflows/{id}/test/email' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "recipients": [
    "user@example.com",
    "test@example.com"
  ],
  "subject": "Welcome to our platform!",
  "emailContent": [
    {
      "type": "paragraph",
      "children": [
        {
          "text": "Thank you for joining us!"
        }
      ]
    }
  ],
  "emailPreviewText": "Get started with your account",
  "name": "Welcome Email Template",
  "senderId": 1,
  "templateId": 2,
  "automationId": 123
}'

Schema ExampleWorkflowPreviewSmsDto

application/json

{
  "phoneNumbers": [
    "<phoneNumbers>",
    "<phoneNumbers>"
  ],
  "smsContent": "Hello! This is a test message from your workflow.",
  "name": "Welcome SMS Template",
  "senderId": 1,
  "automationId": 123,
  "consentId": 4
}

Example · 11 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/automation/visual-workflows/{id}/test/sms' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumbers": [
    "<phoneNumbers>",
    "<phoneNumbers>"
  ],
  "smsContent": "Hello! This is a test message from your workflow.",
  "name": "Welcome SMS Template",
  "senderId": 1,
  "automationId": 123,
  "consentId": 4
}'

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "visualWorkflowNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

phone

string

{
  "name": "string",
  "nodes": {},
  "edges": {},
  "isPublished": true,
  "publishedAt": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "updatedByUser": {
    "userType": "system_admin",
    "tenantId": 0,
    "email": "string",
    "fullName": "<fullName>",
    "phone": "<phone>",
    "emailVerified": "string",
    "phoneVerified": true,
    "isOwner": true,
    "isTestUser": true,
    "image": "string",
    "createdInCheckoutUuid": "string",
    "userRoles": [],
    "notes": [],
    "exportHistory": [],
    "userSettings": {
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "userAccounts": [],
    "userSessions": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "description": "string",
  "isTemplate": true,
  "tenantId": 0,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "workflowRuleId": "string",
  "workflowRule": {
    "rule": {},
    "description": "string",
    "isActive": true,
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "visualWorkflow": {},
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "entityTags": [
    {
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

"visualWorkflowNotFound"

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "workflowSenderNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

502 · application/json

{
  "messageCode": "workflowTestEmailFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "workflowSenderNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Schema ExampleErrorResponse

502 · application/json

{
  "messageCode": "workflowTestSmsFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Get all visual workflows (paginated)#

Parameters

Responses

Responses 200

Create a new visual workflow#

Request body

Get personalized tokens for a workflow#

Parameters

Responses

Responses 200

Get available workflow group tags#

Responses

Responses 200

Responses 401

Get a visual workflow by ID#

Parameters

Responses

Responses 200

Update an existing visual workflow#

Parameters

Request body

Delete a visual workflow#

Parameters

Responses

Responses 200

Set or remove the group tag for a visual workflow#

Parameters

Request body

Duplicate a visual workflow#

Parameters

Request body

Publish a visual workflow#

Parameters

Responses

Responses 200

Unpublish a visual workflow#

Parameters

Responses

Responses 200

Send a test email for a workflow node#

Parameters

Request body

Send a test SMS for a workflow node#

Parameters

Request body

Get all visual workflows (paginated)#

Parameters

Responses

Responses 200

Create a new visual workflow#

Request body

Get personalized tokens for a workflow#

Parameters

Responses

Responses 200

Get available workflow group tags#

Responses

Responses 200

Responses 401

Get a visual workflow by ID#

Parameters

Responses

Responses 200

Update an existing visual workflow#

Parameters

Request body

Delete a visual workflow#

Parameters

Responses

Responses 200

Set or remove the group tag for a visual workflow#

Parameters

Request body

Duplicate a visual workflow#

Parameters

Request body

Publish a visual workflow#

Parameters

Responses

Responses 200