Skip to content

Update an automation edge ​

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

Project automations are rule graphs that run inside one project. Update an automation edge. 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 edge id.

Body parameters ​

execution_order:optionalinteger

Evaluation order when several edges leave the same node.

source_node_id:optionalstring (uuid)

Id of the related source node.

target_node_id:optionalstring (uuid)

Id of the related target node.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.

Requestable here: created_at, created_by_id, execution_order, id, source_node_id, target_node_id, updated_at, updated_by_id, 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.
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 edge
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/edges/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "execution_order": 1,
  "source_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "target_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}'
Response200
json
{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "execution_order": 1,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "source_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "target_node_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "updated_at": "2026-01-15T11:35:48.478363Z",
  "version_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "No automation edge matches the given query."
}