Update a connection

PATCH

/accounts/{accountId}/connections/{connectionId}

• Production management API
• Development stage

Update mapping, eventConfig or status; set the outbound credential.

Authorizations

• bearerAuth

Parameters

Path Parameters

accountId

required

string

connectionId

required

string

Opaque connection id (conn_…).

Request Body ^required

object

label

string

status

string

Allowed values: needs_setup active paused error

mapping

Payload-path ↔ visitor-attribute mapping.

object

key

additional properties

string

outboundCredential

Write-only. The provider credential (e.g. a Segment write key).

string

Responses

200

Updated.

object

connectionId

string

conn_8s9d

accountId

string

provider

string

Allowed values: segment generic

label

string

status

string

Allowed values: needs_setup active paused error

connectMethod

string

Allowed values: webhook marketplace

createdAt

string format: date-time

lastInboundAt

string format: date-time

lastOutboundAt

string format: date-time

401

Missing or invalid authentication/signature.

object

error

object

code

string

invalid_signature

message

string

requestId

string

404

Resource not found.

object

error

object

code

string

invalid_signature

message

string

requestId

string