Sign in
MembershipTypes

Reorder MembershipTypes

Persists a new display order for the caller's MembershipTypes by writing the supplied IDs back to each type's order column in the order they appear in the array. The first ID becomes order 0, the second 1, and so on.

The array must contain only IDs the caller is authorised to manage; IDs missing from the array keep their current order value (i.e. the caller can reorder a subset without listing every type). Returns the updated ordered list, matching listOrderedMembershipTypes.

put/customers/ordered-membership-types

Request body

membership_type_idsstring[] required

The MembershipType IDs in the new display order. The first ID becomes order 0, the second 1, and so on. IDs not included in this array retain their existing order value.

Example request

{
  "membership_type_ids": [
    "9c4d6c4e-3a5a-4f6e-9d6b-1f7e8a9c0b1d",
    "1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"
  ]
}

Response

The MembershipTypes were retrieved in display order.

Example response

{
  "data": [
    {
      "name": "Gold tier"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.