Skip to main content
PATCH
/
connections
/
{connection_id}
{
  "connection_id": "<string>",
  "customer_id": "<string>",
  "retailer_id": "<string>",
  "status": "active",
  "email": "[email protected]",
  "mobile": "+1234567890"
}

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

mobile
string | null

The customer's mobile phone number

Example:

"+1234567890"

Response

Successful Response

connection_id
string
required

A unique identifier for the connection

customer_id
string
required

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

retailer_id
string
required

The unique identifier for the retailer in the connection

status
enum<string>
required

The status of the connection

Available options:
active,
initialized,
unauthenticated,
revoked
email
string | null
required

The customer's email address

mobile
string | null
required

The customer's mobile phone number

Example:

"+1234567890"