Skip to main content
POST
Create an access link for a consumer
Learn more:
  • What is a consumer? ↗
  • How to connect a consumer to a software? ↗
  • Which errors can this endpoint return? ↗

Path Parameters

consumer_id
string<uuid>
required

Body

application/json
syncid
string<uuid> | null

Sync the link opens. The consumer must be linked to it. Cannot be combined with integrationid.

integrationid
integer | null

Integration the link opens the connection page of. It must be active on your account. Cannot be combined with syncid.

expires_at
string<date-time> | null

Date and time after which the link stops working, at most 7 days from now. Defaults to 3 days from now. A value without timezone is read as UTC.

Response

Successful Response

id
string<uuid>
required

Unique id of the access link, used to revoke it

url
string
required

Stable URL to share with the consumer. Each visit opens a fresh 30-minute session until the link expires.

expires_at
string<date-time>
required

Date and time after which the link stops working