Enable or disable a project automation

POST/api/v2/workspaces/{slug}/projects/{project_id}/automations/{pk}/status/

Project automations are rule graphs that run inside one project.

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.

pk:requiredstring (uuid)

The project automation id.

Body Parameters

is_enabled:requiredboolean

Whether the rule is switched on.

Scopes

automations:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Enable or disable a project automation

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/status/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_enabled": false
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/status/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "is_enabled": False
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/automations/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/status/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      is_enabled: false,
    }),
  },
);
const data = await response.json();

Response204

No response body.