Skip to main content
PUT
Update builder connection policy

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

workspace_id
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

integration_type
string
required

ID of the connector, from integration_type in Get workspace connector policies.

Body

application/json

The new value of the switch.

enabled
boolean
required

Whether to turn the switch on (true) or off (false).

Example:

false

Response

The connector's policy.

integration_type
string
required

ID of the connector.

Example:

"googlecalendar"

display_name
string
required

Name of the connector.

Example:

"Google Calendar"

connector_mode
string
required

Which ways the connector can be connected. One of all, shared_only, app_user_only, byo_shared_only, or byo_shared_and_app_user, with the same meaning as connector_mode in List connectors.

Example:

"all"

builder_connection_enabled
boolean
required

Whether the workspace lets builders connect the connector to its apps (true) or has turned that off (false). When it's false, starting a connection is refused.

Example:

true

per_user_connection_enabled
boolean
required

Whether the apps' users can connect their own accounts with the workspace's credentials (true) or not (false). Always false when has_per_user_credentials is false.

Example:

false

has_per_user_credentials
boolean
required

Whether the workspace has set up its own OAuth app credentials for the connector.

Example:

false

not_yet_enabled
boolean
default:false

Whether both switches are off only because the connector became available after the workspace chose to start new connectors off, and nobody has set its policy yet (true). Setting either switch makes it false.

Example:

false