POST

/link-token

Creates a link token to be used when linking a new end user.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

Body Parameters

end_user_email_addressString
Required
Unique ID for your end user.
end_user_organization_nameString
Required
Your end user's organization.
end_user_origin_idString
Required
Your end user's email address.
categoriesArray
Required
The integration categories to show in Merge Link.
integrationString
Optional
The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/.
link_expiry_minsInteger
Required
An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
should_create_magic_link_urlBoolean
Optional
Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/.
Response
JSON
{
  "link_token": "necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0",
  "integration_name": "Lever",
  "magic_link_url": "https://link.merge.dev/asdfjkl12345jsndfgi2i83n"
}

Previous

Linked Accounts

Next Up

Force Resync