Update a workflow

PUT

https://api.contentful.com/spaces/:space_id/environments/:environment_id/workflows/:workflow_id

PUT

/spaces/:space_id/environments/:environment_id/workflows/:workflow_id

$ curl -X PUT https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468 \
>      -H "X-Contentful-Version: 4" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/vnd.contentful.management.v1+json" \
>      -d '{
>   "stepId": "someStepId"
> }'

200Workflows_updateAWorkflow_example

1 {
2   "stepId": "someStepId",
3   "sys": {
4     "id": "someWorkflowId",
5     "type": "Workflow",
6     "environment": {
7       "sys": {
8         "id": "staging",
9         "linkType": "Environment",
10         "type": "Link"
11       }
12     },
13     "space": {
14       "sys": {
15         "id": "yadj1kx9rmg0",
16         "linkType": "Space",
17         "type": "Link"
18       }
19     },
20     "workflowDefinition": {
21       "sys": {
22         "linkType": "WorkflowDefinition",
23         "id": "pfjbpijbJJBNv6Jgj",
24         "type": "Link"
25       }
26     },
27     "entity": {
28       "sys": {
29         "linkType": "Entry",
30         "id": "5KsDBWseXY6QegucYAoacS",
31         "type": "Link"
32       }
33     },
34     "version": 1,
35     "createdAt": "2025-01-20T06:03:04.000Z",
36     "createdBy": {
37       "sys": {
38         "linkType": "AppDefinition",
39         "id": "99SummRPRBowauM8T5Ljb34",
40         "type": "Link"
41       }
42     },
43     "updatedAt": "2025-01-20T06:03:04.000Z",
44     "updatedBy": {
45       "sys": {
46         "linkType": "User",
47         "id": "1xGZIRXr2WPnsLkKfREo0z",
48         "type": "Link"
49       }
50     }
51   }
52 }

Advances or updates a workflow step. Only org or space admins can update by default; step-level permissions can grant access to other users.

Authentication

AuthorizationBearer

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

Path parameters

space_idstringRequired

ID of the space in form of a string

environment_idstringRequired

ID of the environment in form of a string

workflow_idstringRequired

ID of the workflow in form of a string

Headers

X-Contentful-VersionstringRequired

Version of the workflow to update

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful