Using the Household API
Common Customer Workflows
Members who haven't joined a Household
The following workflow outlines how you can:
-
Allow the member to view their pending invites
-
Allow the member to create their own household
Managing Invites
-
Using the Get a Member's Household Invites endpoint, you can get all of the member's outstanding household invites. Each invite will be returned with a household ID and an invite ID.
-
With the household ID and invite ID, you can now accept or reject an invite on behalf of the member using the Update an Invitation endpoint. If an invite is accepted, see the "Members who have joined a household" section below.
Creating a household
If a member is not currently part of a household you can create one using the Create a Household endpoint.
Members who have joined a household
The following workflow outlines how you can:
-
Display household information
-
Manage household invites
-
Change the name of a household
Displaying household information
-
You can get a summary of household information using the Get Household Details endpoint.
-
You can get the activity history of a household using the Household Activity History endpoint and the redemption history of a household is available using the Household Redemption History endpoint.
Managing household invites
-
You can send invites on behalf of a household owner using the Create a Household Invitation endpoint.
-
If at any point the household owner wishes to remove an invite, you can do so using the Update an Invitation endpoint.
NOTE: Only the invitee can accept or reject an invite.
Changing a household's name
You can update the name of a household on behalf of the household owner using the Update a Household Name endpoint.