Skip to Content

PATCH Projects

Use this endpoint to update existing projects.

User level: Advanced

Endpoint

PATCH /v1/{scopeId}/projects/{id}
PropertyValue
MethodPATCH
Scope IDBranch UUID
AuthenticationAuthorization: Bearer <access_token>
Required scoperoutix:projects:write
Content-Typeapplication/json
Request bodyJSON object

Update rules

  • The API validates server-side whether the record belongs to the allowed organization and branch.
  • Only explicitly allowed fields can be updated.
  • Unknown or disallowed fields return 400 invalid_update.

Allowed update fields

Field
name
account_id
status
start_date

Example request

curl -X PATCH "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/projects/92d4d9f6-7a35-4e8e-bd92-cb3f1e5ab8e2" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \ -H "Content-Type: application/json" \ -d '{ "status": "active", "start_date": "2026-07-01" }'

Example response

{ "data": { "id": "92d4d9f6-7a35-4e8e-bd92-cb3f1e5ab8e2", "name": "Warehouse rollout", "account_id": "7ecf4b8d-8d1f-4a0f-8e57-6d8f14c6a221", "status": "active", "start_date": "2026-07-01" }, "version": "v1" }

Error response

{ "error": "invalid_update", "error_description": "One or more fields are not allowed for updates on projects" }

Possible error codes

  • 400 invalid_request
  • 400 invalid_update
  • 401 unauthorized
  • 401 invalid_token
  • 403 invalid_token_type
  • 403 insufficient_scope
  • 404 not_found
  • 405 method_not_allowed
  • Projects GET
  • API calls & examples
  • Setup guide
Last updated on