Content Management API > Workflow

Create a new workflow

Body parameters

id string Optional

RFC 4122 UUID of workflow expressed in URL-safe base64 format

Example:

"uJzC2b6YQg-DW2A5edpQYQ"

name string Required

The name of the workflow

Example:

"Approval by editors required"

stages Required

The stages of the workflow

Type: Array<object>

Example:

[{ id: "waiting_for_review", name: "Waiting for review", initial: true }]

id string Required

ID of the stage

Example:

"waiting_for_review"

name string Required

Name of the stage

Example:

"Waiting for review"

description string, null Optional

Description of the stage

Example:

"Editor has finished writing and is waiting for approval from a supervisor"

initial boolean Optional

Whether this is the initial stage or not

api_key string Required

Workflow API key

Example:

"approval_by_editors"

Returns

Returns a resource object of type workflow

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const workflow = await client.workflows.create({
7
    name: "Approval by editors required",
8
    stages: [
9
      { id: "waiting_for_review", name: "Waiting for review", initial: true },
10
    ],
11
    api_key: "approval_by_editors",
12
  });
13

14
  // Check the 'Returned output' tab for the result ☝️
15
  console.log(workflow);
16
}
17

18
run();

1
{
2
  id: "uJzC2b6YQg-DW2A5edpQYQ",
3
  name: "Approval by editors required",
4
  stages: [
5
    { id: "waiting_for_review", name: "Waiting for review", initial: true },
6
  ],
7
  api_key: "approval_by_editors",
8
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.