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
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_nameString
Required
Your end user's organization.
end_user_origin_idString
Required
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.
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/.
common_modelsArray
Optional
An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
POST v1/link-token
JSON
{
  "end_user_email_address": "string",
  "end_user_organization_name": "string",
  "end_user_origin_id": "string",
  "categories": [
    "hris"
  ],
  "integration": "string",
  "link_expiry_mins": 30,
  "should_create_magic_link_url": false,
  "common_models": [
    {
      "model_id": "hris.Employee",
      "enabled_actions": [
        "READ",
        "WRITE"
      ],
      "disabled_fields": [
        "first_name"
      ]
    }
  ]
}
Response
JSON
{
  "link_token": "necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0",
  "integration_name": "Lever",
  "magic_link_url": "https://link.merge.dev/asdfjkl12345jsndfgi2i83n"
}

Previous

Linked Accounts

Next Up

Selective Sync