Shipeasy
Flags experimentsApiOperations

Update a connector

Partial update — only supplied fields change. events and config replace wholesale; there is no merge or append. Secrets cannot be set through this endpoint…

Partial update — only supplied fields change. events and config replace wholesale; there is no merge or append. Secrets cannot be set through this endpoint (credential rotation goes through the provider-specific re-register flow).

The response carries only { id } — re-fetch via GET /api/admin/connectors/{id} for the new row.

Use cases
  • Pause a connector — { "enabled": false }. Stops all dispatch / auto-fire without deleting it.
  • Change subscribed events — send the full new events array. An empty array unsubscribes the connector from every event.
  • Rename — { "name": "Bugs → acme/app issues" }.
  • Retarget — send a new config (e.g. a different Sheets sheetTitle); it replaces the stored config wholesale.
PATCH
/api/admin/connectors/{id}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque connector id.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://shipeasy.ai/api/admin/connectors/string" \  -H "Content-Type: application/json" \  -d '{    "enabled": false  }'
{
  "id": "9b0e7c2a-1f3d-4a8e-bf21-0c6a2e5d7f10"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page