Response to Invitation
PUT/client/users/:correlation_id/households/:householdID/invites/:inviterAccountID
Created a new CUX API to Response the invitation of a Household
- Create the Secondary member object if invitation accepted
- Delete an INVITE object ( In both cases)
Request
Path Variables
- correlation_id
- householdID
- inviterAccountID
Body
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| status | Contains reply information for invitation | ENUM: "ACCEPTED" or "DECLINED" | Must contain one of these values |
Response
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| message | Generic response message | String | Contains message: "The invitation has been accepted." or "The invitation has been declined." |
Error Responses
| statusCode | errorMessage | errorCode | Definition |
|---|---|---|---|
| 400 | status required to be non-empty | INVALID_REQUEST | status is required field |
| 400 | Could not find the Inviter Account. | INVALID_REQUEST | Inviter Account is not found |
| 400 | Household Member Capacity Limit Exceeded | INVALID_REQUEST | Household member capacity limit is exceeded. |
| 400 | Can not respond invite from an unregistered account. | INVALID_REQUEST | Inviter is unregistered user. |
| 400 | Invitee Not Found. | INVALID_REQUEST | Can not find Invitee by provided details. |
| 400 | Can not respond to invite you are already member of a household. | INVALID_REQUEST | Invitee already belongs to mentioned household |
| 400 | Can not respond to invite, Inviter does not belongs to this household | INVALID_REQUEST | Inviter does not belongs to this household |
| 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
- 400
- 404
- default
200 - Accept Invitation
400 - status Required to Be Non-Empty
Response Headers
Date
Example:
Sat, 25 Mar 2023 07:44:03 GMTContent-Length
Example:
106Connection
Example:
keep-alivex-amzn-RequestId
Example:
1996c2e0-28fc-4b1f-a141-057a28ade4afReferrer-Policy
Example:
no-referrerX-XSS-Protection
Example:
1;mode=blockAccess-Control-Allow-Origin
Example:
*MCK-APPID
Example:
ES-CB-V1MCK-MSGID
Example:
mck-6666fb09-795e-4287-86be-a926d1baa323Expect-CT
Example:
max-age=86400Strict-Transport-Security
Example:
max-age=31536000; includeSubDomains; preloadFeature-Policy
Example:
vibrate 'none'; geolocation 'none'X-Frame-Options
Example:
sameoriginContent-Security-Policy
Example:
connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.netMCK-MSGTIMESTAMP
Example:
March 25th 2023, 7:44:03x-amz-apigw-id
Example:
CU7qnGhmoAMFmUA=cache-control
Example:
no-cache, no-store, must-revalidateMCK_CORRELATIONID
Example:
CORRELATION_ID_NOT_PROVIDED_IN_REQUESTX-Content-Type-Options
Example:
nosniffX-Amzn-Trace-Id
Example:
Root=1-641ea643-4a13374b134b05e761ccb1d6;Sampled=0404 - Config Not Found
Response Headers
Date
Example:
Sat, 25 Mar 2023 07:12:46 GMTContent-Length
Example:
76Connection
Example:
keep-alivex-amzn-RequestId
Example:
b51aad8c-347b-4de7-95b9-e7c2415147f1Referrer-Policy
Example:
no-referrerX-XSS-Protection
Example:
1;mode=blockAccess-Control-Allow-Origin
Example:
*MCK-APPID
Example:
ES-CB-V1MCK-MSGID
Example:
mck-ec3b43c5-30c9-4326-962c-424d36687d21Expect-CT
Example:
max-age=86400Strict-Transport-Security
Example:
max-age=31536000; includeSubDomains; preloadFeature-Policy
Example:
vibrate 'none'; geolocation 'none'X-Frame-Options
Example:
sameoriginContent-Security-Policy
Example:
connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.netMCK-MSGTIMESTAMP
Example:
March 25th 2023, 7:12:46x-amz-apigw-id
Example:
CU3FSEclIAMF5Ng=cache-control
Example:
no-cache, no-store, must-revalidateMCK_CORRELATIONID
Example:
CORRELATION_ID_NOT_PROVIDED_IN_REQUESTX-Content-Type-Options
Example:
nosniffX-Amzn-Trace-Id
Example:
Root=1-641e9eee-1d08777b17cd2a1e5aab23c2;Sampled=0400 - Inviter Account is Unregistered