Create a link
Link a Bilt member to your account with an id_token from the Bilt IdP.
Authorizations
Preferred. An access token your partner client mints with the client credentials grant. Send it only on the Authorization header. It is not the member access token from the code exchange.
Body
The id_token from your code exchange with the Bilt IdP, sent as issued. Its sub names the Bilt member. Do not decode, rewrite, or reuse it.
1 - 8192Your stable, opaque id for the account. It is the only handle for the link afterwards. Do not put personal data in it.
1 - 256Response
Link created. A byte-identical retry of a request that already succeeded returns the same link.
The id of this link episode. Store it; you send it to end the link.
Your account id.
LINKED is the only usable state. UNLINKED means the member or Bilt support ended the link. LINK_REVOKED means you ended it. UNLINKING_IN_PROGRESS means Bilt is calling you to end it: treat it as unusable but not final, and read it again. A new link after UNLINKED or LINK_REVOKED creates a fresh link.
LINKED, UNLINKED, LINK_REVOKED, UNLINKING_IN_PROGRESS When the link was created.
Reserved. Currently always an empty object.