Skip to main content
PATCH
/
connections
/
{connection_id}
Update Connection
curl --request PATCH \
  --url https://api.example.com/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "customer_id": "8a46e581-48ba-498a-9ad0-2ee72582e1af",
  "email": "john.doe@example.com",
  "mobile": "+1234567890",
  "status": "disconnected"
}
'
{
  "connection_id": "<string>",
  "customer_id": "<string>",
  "retailer_id": "<string>",
  "status": "active",
  "email": "alice@example.com",
  "mobile": "+1234567890"
}

Authorizations

​
Authorization
string
header
required

A connection-specific token with access scope

Headers

​
x-api-key
string
required

The client's API key secret value

Path Parameters

​
connection_id
string
required

Body

application/json
​
customer_id
string | null

A unique identifier used to map connections to customer records in external systems.

Example:

"8a46e581-48ba-498a-9ad0-2ee72582e1af"

​
email
string | null

The email of the user

Example:

"john.doe@example.com"

​
mobile
string | null

The customer's mobile phone number

Example:

"+1234567890"

​
status
enum<string> | null

The new status of the connection. Currently can only be used to disconnect a connection.

Available options:
disconnected
Example:

"disconnected"

Response

Successful Response

​
connection_id
string
required

A unique identifier for the connection

Example:

"01J51S0JYV6N7K1030CV1ZKSCA"

​
customer_id
string
required

A unique identifier used to map connections to customer records in external systems.

Example:

"8a46e581-48ba-498a-9ad0-2ee72582e1af"

​
retailer_id
string
required

The unique identifier for the retailer in the connection

Example:

"01J7SC0NN73R6F5VVSP3ZKPDA3"

​
status
enum<string>
required

The status of the connection

Available options:
active,
initialized,
unauthenticated,
disconnected
Example:

"active"

​
email
string | null
required

The customer's email address

Example:

"alice@example.com"

​
mobile
string | null
required

The customer's mobile phone number

Example:

"+1234567890"