CHchift
Consumers

Retrieve the url of a sync for a specific consumer

Changed on

Links the specified consumer to a sync and returns the URL to share with your client so they can complete the connection setup.

post/consumers/{consumer_id}/syncs

Request

Path parameters

consumer_idstring uuid required

Request body

syncidstring uuid required
integrationidsstring[] nullable

[OPTIONAL] Can be used to specify maximum one integrationid for each One API that you want to highlight. If specified, only this connector will be displayed to your clients.

countrystring nullable

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

link_metadataobject nullable

Response

Successful Response

urlstring required

Changes

  • 020884969534Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status