POST
/link-token
https://api.merge.dev/api/ats/v1/link-token
US
EU
APAC
Creates a link token to be used when linking a new end user.
Body parameters
end_user_email_addressStringRequired
Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
end_user_organization_nameStringRequired
Your end user's organization.
end_user_origin_idStringRequired
This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
categoriesArrayRequired
The integration categories to show in Merge Link.
integrationStringOptional
The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
link_expiry_minsIntegerRequired
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_urlBooleanOptional
Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
hide_admin_magic_linkBooleanOptional
Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
category_common_model_scopesObjectBetaOptional
When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
languageEnumOptional
The following subset of IETF language tags can be used to configure localization. Must pass in one of the following choices:
en, de.completed_account_initial_screenEnumOptional
When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. Must pass in one of the following choices:
SELECTIVE_SYNC.