POST
/
consumers
/
{consumerid}
/
connections
Add new connection
curl --request POST \
  --url https://api.chift.eu/consumers/{consumerid}/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "integrationid": 123,
  "name": "<string>",
  "credentials": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "country": "<string>"
}'
{
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumerid
string<uuid>
required

Body

application/json
​
integrationid
integer | null

Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.

​
name
string | null

Can be used to specify the name of the connection. Must be used in combination with an integrationid.

​
credentials
CredentialItem · object[] | null

Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration

​
country
string | null

ISO 3166-1 alpha-2 country code to filter connectors by country. Ignored if integrationid is provided.

Response

Successful Response

​
url
string
required