Update Membership API Documentation

The Update Membership endpoint enables a partner to update personal and programme information for an existing membership. The endpoint updates membership details only when a membership number has been identified and a valid access token has been received.

The Update Membership endpoint accepts partial membership information updates. For example, the address could be passed in the endpoint request in isolation, without other details. In this scenario, only the address will be updated and the other pre-existing data will remain unchanged. The endpoint allows the postal address not to be validated and will allow it to stay in the format provided.

Business Context

Here’s the process flow:

• A member is identified in the partner application and initiates an change to their profile data.
• The partner will capture the profile update, which may be partial (for example, just the member's address).
• The partner will invoke the Update Membership endpoint providing the membership profile update and a valid access token, along with other pertinent data elements as described in the request section of this document.
• The Update Membership endpoint validates the incoming request and stores the updated membership profile information within the IAG Loyalty Platform. If the request is unsuccessful, an error message is returned.
• The partner facilitates the member's onward journey through their channels.

Important Technical Notes

• Request element values may be provided in either upper/lower case ASCII characters or accented characters, which will be stored in upper case ASCII format. The endpoint allows a postal address to be passed in the request without any validation by setting the appropriate flag in the request.
• Where Postal Address validation occurs, the format of the retained address will be standardised.
• When invoking the Update Membership service, a partial request may be provided. Any type that is not provided will not be updated as part of the execution of the request. For example, postal address may be passed with the name omitted. However, the partial request must still be presented in the correct format and aligned to the specification.
• Country of Residence, Title and Date of Birth fields can only be provided using the Update Membership endpoint if they are not already present on the member’s account. (i.e; They can be added, but cannot be updated.)
• Any accented characters provided in the request will be converted to uppercase ASCII.

Pre-conditions

• The partner must have a valid API key to access the Update Membership endpoint
• The member must have previously identified themselves by logging in, at which point the Partner will have received a valid Access Token for the member for use with Update Membership API requests
• A Member Account must have been successfully created via Join Programme endpoint, or IAG Loyalty channels
• A Security Profile for the member account must have been created via the Join Programme endpoint or Register Account API.

Post-conditions

Success outcome: HTTP status code 204 is returned with an empty response body.

Error outcome: Service error is returned.

Service Details

URI Parameters

Production Endpoint:

PATCH https://api.avios.com/{version}/memberships/{membership-identifier}?api_key={api_key}

Example

https://api.avios.com/v3/memberships/3081470000000000?api_key=abcdef

Test Endpoint:

https://api.avios.com/test/{version}/memberships/{membership-identifier}?api_key={api_key}

Request Headers

Request Elements

The following is an example of a request call to the Update Membership endpoint:

{
  "member": {
    "person": {
      "emailAddresses": {
        "preferredEmailAddress": {
...Show more

Exception Message Elements

The exception message responses may be formatted in either upper or lower case. An example of an error response is shown:

{
  "code": "REQUEST_UNAUTHORIZED",
  "businessMessage": "Request Unauthorized",
  "developerMessage": "Request Unauthorized",
  "developerLink": "https://developer.iagloyalty.com/docs",
...Show more

Error codes