Skip to main content
POST
Turn automatic GitHub sync on or off

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app whose GitHub sync this affects.

Body

application/json

The automatic sync setting to apply.

enabled
boolean
required

Whether to turn automatic sync on or off. Send true to turn it on and false to turn it off.

Example:

false

Response

The setting was saved.

success
boolean
required

Always true. A change that can't be applied is rejected with an error status instead.

Example:

true

sync_enabled
boolean
required

Whether automatic sync is now on. The value is true when it's on and false when it's off, and it always matches what you sent.

Example:

false