Invitation to Member

POST 
/client/users/:correlation_id/households/:household_id/invites

If the inviter is not a part of any household and sends an invite to another member, the following actions take place behind the scenes:

• Set up the HOUSEHOLD with Household ID(AccountID) = Primary member’s AccountID
• Create the PRIMARY member object
• Create an INVITE object for the invitee

If the inviter is part of a household and sends an invite to another member, the following actions will take place:

• Create an INVITE object for the invitee

Request

Path Variables

• correlation_id
• householdID

Body

Attribute	Definition	Format	Notes
identifierType	Contains identifying information to be sent in the request.	ENUM: "LOYALTY_ID" or "EMAIL"
identifierValue	Identifier value of the invitee.	String	Depending on identifierType selected, this is a valid email address or loyalty card number

Response

Attribute	Definition	Format	Notes
message	Generic response message	String	Contains success message: "The invitation has been sent successfully."

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	Invitation already sent	INVALID_REQUEST	Invitation already sent to invitee.
400 Bad Request	Invitee is already member of household.	INVALID_REQUEST	Invitee already belongs to this household.
400 Bad Request	Cannot send invite from an unregistered account.	INVALID_REQUEST	Inviter is unregistered user.
400 Bad Request	Could not send invite, Member does not belong to the mentioned household	INVALID_REQUEST	Inviter is not belongs to designated household.
400 Bad Request	Member does not have INVITE MEMBER privilege.	INVALID_REQUEST	Inviter requires INVITE MEMBER privilege to send invitation to a household.
400 Bad Request	Household Member Capacity Limit Exceeded	INVALID_REQUEST	Household member capacity limit is exceeded.
400 Bad Request	Member Daily Invite Capacity Limit Exceeded	INVALID_REQUEST	Inviter daily capacity limit exceeded.
400 Bad Request	Could not find the Inviter Account.	INVALID_REQUEST	Inviter Account is not found.
400 Bad Request	Invitee Not Found.	INVALID_REQUEST	Cannot find Invitee by provided details.
400 Bad Request	identifierValue required to be non-empty	INVALID_REQUEST	The identifierValue value is empty.
400 Bad Request	identifierType required to be non-empty	INVALID_REQUEST	The identifierType value is empty.
400 Bad Request	identifierType should be one of EMAIL, LOYALTY_ID.	INVALID_REQUEST	The identifierType must have a valid value.
404 Not Found	Config Not found	NOT_FOUND	Config does not exist in database.
404 Not Found	Household Template Not Found	NOT_FOUND	Household template does not exist.

Request

Responses

200

200 - Invite to Member (Created Household, Primary Member and Invite Object)

Response Headers

Date
Example: Sat, 25 Mar 2023 06:34:48 GMT
Content-Length
Example: 56
Connection
Example: keep-alive
x-amzn-RequestId
Example: 58232fbc-77bd-47bf-85c5-cf29b185a2f9
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-9c62f5de-9e5f-4c80-bcd7-9dc9818a3b6e
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: March 25th 2023, 6:34:47
x-amz-apigw-id
Example: CUxg8HcOoAMFfkg=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-641e9605-54a8c3c5785c42f07bcf6b00;Sampled=0

400

400 - Invitation Already Sent

Response Headers

Date
Example: Sat, 25 Mar 2023 06:37:52 GMT
Content-Length
Example: 89
Connection
Example: keep-alive
x-amzn-RequestId
Example: e61fa2fc-f5b5-4ded-b9c1-b7da28122152
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-0196c773-0457-44b8-8309-2b70a248b94c
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: March 25th 2023, 6:37:52
x-amz-apigw-id
Example: CUx-HH8XoAMFSLA=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-641e96c0-4c91051c6f6fe260075d23de;Sampled=0

404

404 - Config Not Found

Response Headers

Date
Example: Sat, 25 Mar 2023 07:12:46 GMT
Content-Length
Example: 76
Connection
Example: keep-alive
x-amzn-RequestId
Example: b51aad8c-347b-4de7-95b9-e7c2415147f1
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-ec3b43c5-30c9-4326-962c-424d36687d21
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: March 25th 2023, 7:12:46
x-amz-apigw-id
Example: CU3FSEclIAMF5Ng=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-641e9eee-1d08777b17cd2a1e5aab23c2;Sampled=0