Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Membership Hold

Edits a Membership Hold in a Membership

This edits a Membership Hold in a Membership.

put/memberships/{membership_id}/holds/{hold_id}

Path parameters

membership_idinteger required

Membership Id

hold_idinteger required

Membership Hold Id

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

start_datestring date

Date on which the hold starts.

end_datestring date

Date on which the hold ends.

hold_reason_idinteger

Identifies the hold reason.

is_snooze_in_retainstring

is snooze in retain

Example request

{
  "start_date": "2014-12-31",
  "end_date": "2014-12-31",
  "hold_reason_id": 1234567891234567
}

Response

created MembershipHold

membership_idinteger required

id of the membership

Example response

{
  "membership_id": 1234567891234567,
  "hold": {
    "id": 1234567891234567,
    "start_date": "2014-12-31",
    "end_date": "2014-12-31"
  }
}