Create a workflow | Documentation

curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/workflows \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "stepId": "someStepId",
  "entity": {
    "sys": {
      "type": "Link",
      "linkType": "Entry",
      "id": "5KsDBWseXY6QegucYAoacS"
    }
  },
  "workflowDefinition": {
    "sys": {
      "type": "Link",
      "linkType": "WorkflowDefinition",
      "id": "someWorkflowDefinitionId"
    }
  }
}'

{
  "stepId": "someStepId",
  "sys": {
    "id": "someWorkflowId",
    "type": "Workflow",
    "environment": {
      "sys": {
        "id": "staging",
        "linkType": "Environment",
        "type": "Link"
      }
    },
    "space": {
      "sys": {
        "id": "yadj1kx9rmg0",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "workflowDefinition": {
      "sys": {
        "linkType": "WorkflowDefinition",
        "id": "pfjbpijbJJBNv6Jgj",
        "type": "Link"
      }
    },
    "entity": {
      "sys": {
        "linkType": "Entry",
        "id": "5KsDBWseXY6QegucYAoacS",
        "type": "Link"
      }
    },
    "version": 1,
    "createdAt": "2025-05-01T01:04:58.000Z",
    "createdBy": {
      "sys": {
        "linkType": "AppDefinition",
        "id": "99SummRPRBowauM8T5Ljb34",
        "type": "Link"
      }
    },
    "updatedAt": "2025-05-01T01:04:58.000Z",
    "updatedBy": {
      "sys": {
        "linkType": "User",
        "id": "1xGZIRXr2WPnsLkKfREo0z",
        "type": "Link"
      }
    }
  }
}

Creates a workflow for an entry. Any user with read access to the entry can create a workflow.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

space_id identifier

environment_idstringRequired

environment_id identifier

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

Created - Resource created successfully