Skip to main content
POST
/
connections
Create Connection
curl --request POST \
  --url https://api.example.com/connections \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "customer_id": "<string>",
  "retailer_id": "<string>",
  "email": "[email protected]",
  "mobile": "+1234567890"
}
'
{
  "connection_id": "<string>",
  "customer_id": "<string>",
  "retailer_id": "<string>",
  "status": "active",
  "email": "[email protected]",
  "mobile": "+1234567890"
}

Headers

​
x-api-key
string
required

The client's API key secret value

Body

application/json
​
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

Examples:

"walmart"

"target"

"amazon"

​
email
string | null

The customer's email address

Example:

"[email protected]"

​
mobile
string | null

The customer's mobile phone number

Example:

"+1234567890"

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,
revoked
Example:

"active"

​
email
string | null
required

The customer's email address

Example:

"[email protected]"

​
mobile
string | null
required

The customer's mobile phone number

Example:

"+1234567890"