members

Update member

Changed on

Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.

put/users/{user_guid}/members/{member_guid}

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/members/{member_guid}
  • Auth
    HTTP basic

Path parameters

member_guidstring required

The unique id for a member.

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Headers

X-CALLBACK-PAYLOADstring

The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.

Request body

Example request

{
  "member": {
    "credentials": [
      {
        "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
        "value": "password"
      }
    ],
    "id": "unique_id",
    "metadata": "\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\",
    "use_cases": [
      "PFM"
    ]
  }
}

Response

OK

Changes

  • e74cd2b059b5Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      api tag members added

    • info

      api tag mx_platform removed

    • info

      added the new optional header request parameter X-CALLBACK-PAYLOAD

    • info

      added the new optional request property /

  • b904662f5441Revision changes
    • breaking

      the / response's property type changed from string to integer for status

    • breaking

      the / response's property type changed from string to boolean for status

    • warning

      added the new MONEY_MOVEMENT enum value to the // response property for the response status

    • warning

      added the new PFM enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status