Skip to content

Update an automation node ​

PATCH/api/v2/workspaces/{slug}/projects/{project_id}/automations/{automation_id}/nodes/{pk}/

Project automations are rule graphs that run inside one project. Update an automation node. Send only the keys you want to change — omitted keys keep their current value, and an explicit null clears a nullable field.

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

automation_id:requiredstring (uuid)

The automation the resource belongs to.

pk:requiredstring (uuid)

The automation node id.

Body Parameters ​

config:optionalstring

Node-specific configuration and parameters

handler_name:optionalstring

Name of the handler class (e.g., 'record_created', 'send_email')

Maximum 100 characters.

is_enabled:optionalboolean

Whether the rule is switched on.

name:optionalstring

Display name for the node

Maximum 255 characters.

node_type:optionalstring

Type of node: trigger, action, or condition

  • trigger - Trigger
  • action - Action
  • condition - Condition

One of trigger, action, condition.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: config, created_at, created_by_id, handler_name, id, is_enabled, last_triggered_at, name, next_scheduled_at, node_type, updated_at, version_id.

Scopes ​

automations:write

Errors ​

StatusCodeCause
400invalid_requestThe request body or a query parameter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan or is switched off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictA business rule blocks the write — see the notes above.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Update an automation node
bash
curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/nodes/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "config": null,
  "handler_name": "example",
  "is_enabled": false
}'
Response200
json
{
  "config": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "handler_name": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_enabled": false,
  "last_triggered_at": "2026-01-14T09:22:41.478363Z",
  "name": "Example name",
  "next_scheduled_at": "2026-01-14T09:22:41.478363Z",
  "node_type": null,
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "version_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "No automation node matches the given query."
}