Create RecordCreationWorkflow

POST

api

sys

recordcreationworkflows

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/recordcreationworkflows \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "EntityDomain": "<string>",
  "EntityType": "<string>",
  "Status": 123,
  "SourceType": 123,
  "CreatedByUserId": 123,
  "UpdatedByUserId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/recordcreationworkflows"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "EntityDomain": "<string>",
    "EntityType": "<string>",
    "Status": 123,
    "SourceType": 123,
    "CreatedByUserId": 123,
    "UpdatedByUserId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    EntityDomain: '<string>',
    EntityType: '<string>',
    Status: 123,
    SourceType: 123,
    CreatedByUserId: 123,
    UpdatedByUserId: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/recordcreationworkflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A business-scoped record creation workflow with draft and published versions.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the RecordCreationWorkflow-Create role.

Enums

eRecordCreationWorkflowStatus — Status values

Value	Name
1	Draft
2	Published
3	Archived

eRecordCreationWorkflowSourceType — SourceType values

Value	Name
1	Blank
2	BuiltIn
3	Generated
4	Duplicated

Request Body

Required Fields

integer

required

ID of the business that owns this workflow.

string

required

Display name of the workflow.

string

required

Domain of the entity created by this workflow.

string

required

Type of entity created by this workflow.

integer

required

Current lifecycle status of the workflow.

integer

required

How this workflow was originally created.

integer

required

User who created the workflow.

integer

required

User who last updated the workflow.

Optional Fields

string

Optional description of the workflow.

string

Stable key of the source template.

string

Revision of the source template when copied.

boolean

Whether this is the default published workflow for its entity.

integer

Current mutable draft version.

integer

Current immutable published version.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/recordcreationworkflows" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "EntityDomain": "",
    "EntityType": "",
    "Status": 0,
    "SourceType": 0,
    "CreatedByUserId": 0,
    "UpdatedByUserId": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/recordcreationworkflows',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      EntityDomain: '',
      EntityType: '',
      Status: 0,
      SourceType: 0,
      CreatedByUserId: 0,
      UpdatedByUserId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/recordcreationworkflows',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'EntityDomain': '',
        'EntityType': '',
        'Status': 0,
        'SourceType': 0,
        'CreatedByUserId': 0,
        'UpdatedByUserId': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the recordcreationworkflow was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "RecordCreationWorkflow was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create RecordCreationWorkflow

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/recordcreationworkflows \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "EntityDomain": "<string>",
  "EntityType": "<string>",
  "Status": 123,
  "SourceType": 123,
  "CreatedByUserId": 123,
  "UpdatedByUserId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/recordcreationworkflows"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "EntityDomain": "<string>",
    "EntityType": "<string>",
    "Status": 123,
    "SourceType": 123,
    "CreatedByUserId": 123,
    "UpdatedByUserId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    EntityDomain: '<string>',
    EntityType: '<string>',
    Status: 123,
    SourceType: 123,
    CreatedByUserId: 123,
    UpdatedByUserId: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/recordcreationworkflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create RecordCreationWorkflow

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400