Skip to content

Update connector

PUT/integrations/connectors/{id}

Updates an existing connector account's configuration or credentials. Omitting config_json or credentials_json preserves existing values. Use this to rotate credentials or update scopes without recreating the connector.

Request

Path parameters

NameTypeRequiredDescription
idintegerYes

Integer ID of the connector to update.

Example: 4

Request body

Content type application/json (required).

FieldTypeRequiredDescription
namestringYes

Connector display name.

Max length: 120

keystring, nullableNo

Optional machine key; auto-derived if omitted.

Max length: 80

typestringYes

External system category.

One of: "crm", "support", "analytics", "messaging", "storage", "custom"

auth_typestringYes

Authentication mechanism.

One of: "api_key", "oauth2", "none"

statusstringNo

Operational status.

One of: "active", "inactive", "error" · Default: "active"

config_jsonstring, nullableNo

JSON-encoded non-sensitive configuration object.

credentials_jsonstring, nullableNo

JSON-encoded sensitive credentials object (write-only, stored encrypted).

Example

{
  "name": "Salesforce CRM",
  "type": "crm",
  "auth_type": "oauth2",
  "status": "active",
  "credentials_json": "{\"client_id\":\"NEW_CLIENT_ID\",\"client_secret\":\"NEW_SECRET\"}"
}

Responses

302 Redirect to connectors list after update

404 Connector not found

422 Validation error

Example request

curl -X PUT "https://{tenant}.faciotech.net/api/v1/integrations/connectors/{id}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name": "Salesforce CRM", "type": "crm", "auth_type": "oauth2", "status": "active", "credentials_json": "{\"client_id\":\"NEW_CLIENT_ID\",\"client_secret\":\"NEW_SECRET\"}"}'
Loading