Sign in
SignupTokens

Update a SignupToken

Update an existing SignupToken. Only fields included in the request body will be changed.

put/customers/signup-tokens/{signupTokenId}

Request body

membership_type_idstring

The MembershipType this token allows signups as

membership_rate_idstring

The MembershipRate this token allows signups as. This must belong to the same MembershipType as the one provided. If omitted, the default rate of the given type will be used.

start_datestring date

Optionally, you can specify the date which the membership should start.

end_datestring date nullable

Optionally, you can specify the date which the membership should end.

durationstring

Optionally, you can specify the duration of the membership as an ISO8601 string. See https://en.wikipedia.org/wiki/ISO_8601#Durations

max_usesinteger nullable

The maximum number of times this signup token can be used. If null, it can be used an unlimited number of times.

first_namestring

The first name of the customer this token allows signups as.

last_namestring

The last name of the customer this token allows signups as.

emailstring nullable

The email of the customer this token allows signups as.

Example request

{
  "membership_type_id": "000000-000000-000000-000000",
  "membership_rate_id": "000000-000000-000000-000000",
  "start_date": "2021-02-21",
  "end_date": "2022-02-21",
  "duration": "P1M",
  "max_uses": 1,
  "first_name": "Dan",
  "last_name": "Johnson",
  "email": "dan.johnson@example.com"
}

Response

The signup token was successfully retrieved or updated.

Example response

{
  "data": {
    "id": "000000-000000-000000-000000",
    "membership_type_id": "000000-000000-000000-000000",
    "membership_rate_id": "000000-000000-000000-000000",
    "start_date": "2021-02-21",
    "end_date": "2022-02-21",
    "duration": "P1M",
    "first_name": "Dan",
    "email": "dan@try.be"
  }
}

Changes

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