POST
/
v1
/
customers
/
{customer_id}
/
connect-link
Create a connect link
curl --request POST \
  --url https://api.amberflow.io/v1/customers/{customer_id}/connect-link \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "location_id": null,
  "language": "en-US"
}'
{
  "url": "www.connect.amberflow.io/8Jha991alsd",
  "valid_until": "2024-09-23T00:00:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
customer_id
string
required

Body

application/json
​
location_id
string | null

The location to connect to. If no location is provided, it will default to the first location in the customer.

Examples:

null

​
language
enum<string> | null

The language for the connect session. If no language is provided, it will default to the Customer language.

Available options:
en-US,
nl-NL
Examples:

"en-US"

"nl-NL"

Response

Successful Response

​
url
string
required

The URL to connect to the customer

Examples:

"www.connect.amberflow.io/8Jha991alsd"

​
valid_until
string<date-time>
required
Examples:

"2024-09-23T00:00:00.000Z"