Skip to main content
Either side can end a link, and both unlink calls are idempotent.

​
Before you begin

​
How it works

When the member disconnects in the Bilt app, Bilt calls you. When your customer disconnects in your product, you call Bilt. Either way the link ends, and both sides converge on the same state.

​
Steps

Bilt calls Unlink an account when the member disconnects your product in the Bilt app. It uses the same bearer credential as your other endpoints.
1

Find the link

Look the link up by partnerMemberId. Return 404 LINK_NOT_FOUND when there is none. Bilt treats that as a successful unlink.
2

Check the member

When Bilt sends biltMemberId, check that it matches the stored link. Return 409 MEMBER_ID_MISMATCH when it does not.
3

Clean up

Return 200. Then delete the stored biltMemberId, remove your link records for the member, and stop sending their activity to Bilt.
Call End a link when your customer disconnects Bilt in your product or closes their account.
  • Authenticate with your partner access token, not the credential you issued to Bilt. That credential returns 401.
  • Send the partnerUserId and the linkId from the create or get response. The linkId stops a delayed retry from ending a newer link.
  • A 204 means the link is LINK_REVOKED, and the member stops earning. A repeat also returns 204.
  • A 404 LINK_NOT_FOUND means no link of yours has that ID. Clean up and treat it as done.
A 409 INVALID_STATE_TRANSITION means the link is mid-transition, which happens only for partners Bilt calls on unlink. Wait one to two seconds and resend. If it persists, contact Bilt with the requestId. When your own unlink flow finds no linked account, answer your UI with an error such as NO_LINKED_ACCOUNT.

​
What can go wrong

​
Next steps