Create team link

Creates a team link for the subaccount: the route for the SDK's "Invite your team"
ending, which calls it with the SDK token's card-subscriptions:write. An API client
may call it with subaccounts:write. No body.

_links.team-link on GET /subaccounts/{subaccountId} points here when the route is
available to the caller.

The link has the team defaults: it expires after 14 days and allows 50 session starts.
The response holds only what the SDK screen shows, and is sent with
Cache-Control: no-store. Every call makes a new link. A new link does not revoke an
older one: each link ends at its own expiry, when its session starts are used up, or
when it is revoked. Revoke a link you no longer want shared with
POST /enrollment-links/{linkId}/revoke.

Refusals carry a code:

  • 403 LINK_SESSION_FORBIDDEN: the token is an enrollment link session's. It holds
    card-subscriptions:write too, but cannot make links.
  • 404 SUBACCOUNT_NOT_FOUND: the subaccount is not one of your account's.
  • 409 ENROLLMENT_LINKS_NOT_ENABLED: enrollment links are not enabled for your
    account.
  • 409 CARD_ENROLLMENT_OFF: card enrollment is off for the subaccount (its
    enrollmentPolicy.cardEnrollment is false). The hosted page offers card enrollment
    only, so a link would have nothing to enroll. This check runs before the daily limits
    are counted, so a refused request does not use them up.
  • 429 RATE_LIMITED: 20 links were made here for the subaccount today (UTC), or your
    account has created 2,000 links today.

A link made before card enrollment was turned off starts no session while card
enrollment stays off: POST /enrollment-link-sessions/preview and
POST /enrollment-link-sessions answer 409 CARD_ENROLLMENT_OFF, and no start is
counted.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Headers
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json