Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Membership Hold

Adds a Membership Hold to a Membership

This creates a Membership Hold for a Membership.

post/memberships/{membership_id}/holds

Path parameters

membership_idinteger required

Membership 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 required

Date on which the hold starts.

end_datestring date required

Date on which the hold ends.

hold_reason_idinteger required

Identifies the hold reason.

is_snooze_in_retainboolean

Indicates if the Client should be snoozed in Retain during their hold

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"
  }
}