Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Membership Hold Reason

Update Membership Hold Reason

Updates an existing Membership Hold Reason.

put/memberships/holds/reasons/{hold_reason_id}

Path parameters

hold_reason_idinteger required

The Id of the Hold Reason to update.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Request body

hold_reasonstring required

The Name of the Hold Reason

is_in_usestring

Determines if the Hold Reason is active and able to be used. Defaults to True if not provided.

orderinteger

The order of the Hold Reason. If the order provided is already in use by another Hold Reason, this Hold Reason will take its place and the reamining Hold Reasons will increment or decrement respectively.

Response

Hold Reason Data

hold_reason_idinteger

Identifies the hold reason.

hold_reasonstring

Hold reason.

is_in_useboolean

the IsActivce column

orderinteger

order

Example response

{
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}