Skip to main content
PATCH
Rename a connector

Authorizations

Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Path Parameters

connector_id
string
required

The ID of the connector to rename.

Body

application/json
display_name
string
required

Short human-readable name of the connector.

Required string length: 1 - 200
Example:

"Invoice retrieval"

Response

Successful response

id
string
required

Unique identifier for the object.

Example:

"conn_8kPq2mWxYz1aBcDeFgHi3J"

display_name
string
required

Short human-readable name of the connector.

Example:

"Invoice retrieval"

purpose
string
required

What the connector does, as specified at publish time.

Example:

"Retrieve invoices from our ERP system, including refunds."

website
string | null
required

Website the connector operates against.

Example:

"https://example.com"

input_schema
object
required

JSON Schema for the connector's run arguments.

output_schema
object
required

JSON Schema for the connector's run results.

revised_from_connector_id
string | null
required

Connector this one revised (if any).

created_at
string<date-time>
required

Timestamp when the object was created.

required_secrets
SecretSlotDefinition · object[]

Secret slots that must be bound when running the connector.