Leave Household

DELETE 
/client/users/:correlation_id/household

Used to delete a member from a household. If the Primary member is deleted, then the household is disbanded and deleted as it cannot function without a Primary member; a message is returned to indicate that the member has been deleted and the household disbanded. If a Secondary member is deleted, then the household remains intact; a message is returned indicating that the member was deleted.

Request

Body

There is no body for this request.

Response

Attribute	Description	Format	Note
message	Provides a message about the deletion of a Primary or Secondary member.	String	If the member was a Primary, the message also notes that the household has been disbanded.

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	Account is not part of a household	INVALID_REQUEST	The account indicated does not belong to a household.

Request

Responses

200

200 - Primary Member Leaves Household

Response Headers

Date
Example: Wed, 05 Apr 2023 15:09:03 GMT
Content-Length
Example: 65
Connection
Example: keep-alive
x-amzn-RequestId
Example: 2ecdf15f-9ef8-4150-8a7f-bab20fcbd631
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-731dd28e-2940-4b4b-87cd-50ee41f5cfc1
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: April 5th 2023, 3:09:03
x-amz-apigw-id
Example: C6NKcG_4IAMFthQ=
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-642d8f0f-4d49aca76952041029d465bf;Sampled=0;lineage=4373a234:0

400

400 - Account Not In Household

Response Headers

Date
Example: Wed, 05 Apr 2023 15:04:53 GMT
Content-Length
Example: 100
Connection
Example: keep-alive
x-amzn-RequestId
Example: 53055369-3f0d-45dc-aebc-54eb00b23d8a
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-fb1a5669-8831-43bd-bdb4-a91302dd8ff3
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: April 5th 2023, 3:04:52
x-amz-apigw-id
Example: C6MjSFwEIAMF50g=
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-642d8e14-11f360803f55f701728125fb;Sampled=0;lineage=4373a234:0