Skip to content
AppHandoff AppHandoff Docs

Update a project rule

PATCH
/projects/{id}/rules/{ruleId}
 
curl --request PATCH \
  --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "content": "example", "sort_order": 1 }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Project UUID

ruleId
required
string format: uuid

Rule UUID

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
string
>= 1 characters <= 500 characters
content
string
sort_order
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Rule updated

Media type application/json
object
rule
required
object
id
required
string format: uuid
project_id
required
string format: uuid
name
required
string
>= 1 characters <= 500 characters
content
required
string
sort_order
required
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time

400

Section titled “400 ”

Invalid request

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number
reconnect

True if re-linking GitHub may fix the issue

boolean

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number