Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Connections

Add new connection

Returns the url that can be used by your client to enable his integrations.

post/consumers/{consumer_id}/connections

Path parameters

consumer_idstring uuid required

Request body

integrationidinteger nullable

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

namestring nullable

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

countrystring nullable

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

redirectboolean nullable

Indicates whether you want to return to the consumer's redirectUrl after creation (true) or whether you want to stay on the connection selection page (false)(This field is ignored if integrationid is provided)

apisstring[] nullable

Can be used to filter connectors by APIs. Ignored if integrationid is provided.

Response

Successful Response

urlstring required