Skip to main content

Add Household Member (in Transition Period)

POST 
/client/users/:correlation_id/household/members

An administrator want to add households without creating an Invite object during the transition period (while member data is being migrated/synched) to the ES Loyalty platform. With inTransition = true in configuration, the following takes place to establish a household and its members.

This API will create the following objects:

If the primary member is not a part of any household, 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 the SECONDARY member object.

If the primary member is part of a household, the following actions take place:

  • Create the SECONDARY member object

This endpoint creates the necessary objects; no INVITE object is created. The request is rejected if inTransition config is false.

Request​

Path Variables​

  • correlation_id
  • householdID

Body​

AttributeDefinitionFormatNotes
identifierTypeContains identifying information to be sent in the request.ENUM: "LOYALTY_ID" or "EMAIL"
identifierValueIdentifier value of the invitee.StringDepending on identifierType selected, this is a valid email address or loyalty card number

Response​

AttributeDefinitionFormatNotes
messageGeneric response messageStringContains success message: "The invitation has been sent successfully."

Error Responses​

statusCodeerrorMessageerrorCodeDefinition
400 Bad RequestinTransition is not enabled.INVALID_REQUESTThe configuration inTransition = false, so this request cannot be used to establish a household or add members.
400 Bad RequestHousehold Member Capacity Limit ExceededINVALID_REQUESTThe limit on the number of household members cannot be exceeded.
400 Bad RequestidentifierType should be one of EMAIL, LOYALTY_ID.INVALID_REQUESTThe identifierType must have a valid value.
400 Bad RequestMember already exist in the household.INVALID_REQUESTThe request was made using CARD and the member already exists in the household.
400 Bad RequestSecondary member already exist in the household.INVALID_REQUESTThe request was made using EMAIL and the member already exists in the household.
400 Bad RequestMember is already part of another household.INVALID_REQUESTThe member is already part of a different household and cannot be added to this one.

Request​

Responses​

200 - Add Household Member

Response Headers
    Date
    Example: Thu, 13 Apr 2023 18:40:02 GMT
    Content-Length
    Example: 53
    Connection
    Example: keep-alive
    x-amzn-RequestId
    Example: 9d5516ff-4683-4279-a647-f0084e409c37
    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-5d0ae009-5ea1-40fd-95ce-577df8fd45c0
    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 13th 2023, 6:40:02
    x-amz-apigw-id
    Example: DVDkWETRIAMFcFg=
    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-64384c81-5afabad7199e361307e84277;Sampled=0;lineage=815bc71e:0
Last updated on