NAV Navigation
Shell HTTP JavaScript Ruby Python PHP Java Go

Mariana Tek Webhooks API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

You can use webhooks to receive notifications about particular events in Mariana's platform. Mariana will send events to a url that you configure, instead of having to make API calls periodically to check for updates. For example, you can rely on webhooks to trigger an action in your app/integration when a customer creates an account, makes a reservation, or checks in to class. By using webhook subscriptions you can make fewer API calls overall and respond to events in real time, which makes sure that your custom apps and integrations are more efficient and update quickly. Please contact integrations@marianatek.com to start using webhooks.

Email: Support

Profile

Receive updates when new accounts are created and updated.

post_profile.created

Code samples

# You can also use wget
curl -X POST /profile.created \
  -H 'Content-Type: application/json'

POST /profile.created HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "profile.created",
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/profile.created',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/profile.created',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/profile.created', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/profile.created', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/profile.created");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/profile.created", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST profile.created

Body parameter

{
  "action": "profile.created",
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ProfileCreatedEvent false none

Responses

Status Meaning Description Schema

post_profile.updated

Code samples

# You can also use wget
curl -X POST /profile.updated \
  -H 'Content-Type: application/json'

POST /profile.updated HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "profile.updated",
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/profile.updated',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/profile.updated',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/profile.updated', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/profile.updated', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/profile.updated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/profile.updated", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST profile.updated

Body parameter

{
  "action": "profile.updated",
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ProfileUpdatedEvent false none

Responses

Status Meaning Description Schema

Reservation

Receive updates for reservations.

post_reservation.created

Code samples

# You can also use wget
curl -X POST /reservation.created \
  -H 'Content-Type: application/json'

POST /reservation.created HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.created",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.created',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.created',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.created', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.created', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.created");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.created", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.created

Body parameter

{
  "action": "reservation.created",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationCreatedEvent false none

Responses

Status Meaning Description Schema

post_reservation.checkedin

Code samples

# You can also use wget
curl -X POST /reservation.checkedin \
  -H 'Content-Type: application/json'

POST /reservation.checkedin HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.checkedin",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.checkedin',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.checkedin',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.checkedin', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.checkedin', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.checkedin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.checkedin", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.checkedin

Body parameter

{
  "action": "reservation.checkedin",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationCheckedInEvent false none

Responses

Status Meaning Description Schema

post_reservation.checkedout

Code samples

# You can also use wget
curl -X POST /reservation.checkedout \
  -H 'Content-Type: application/json'

POST /reservation.checkedout HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.checkedout",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.checkedout',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.checkedout',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.checkedout', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.checkedout', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.checkedout");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.checkedout", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.checkedout

Body parameter

{
  "action": "reservation.checkedout",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationCheckedOutEvent false none

Responses

Status Meaning Description Schema

post_reservation.cancelled

Code samples

# You can also use wget
curl -X POST /reservation.cancelled \
  -H 'Content-Type: application/json'

POST /reservation.cancelled HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.cancelled",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.cancelled',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.cancelled',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.cancelled', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.cancelled', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.cancelled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.cancelled", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.cancelled

Body parameter

{
  "action": "reservation.cancelled",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationCancelledEvent false none

Responses

Status Meaning Description Schema

post_reservation.noshowed

Code samples

# You can also use wget
curl -X POST /reservation.noshowed \
  -H 'Content-Type: application/json'

POST /reservation.noshowed HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.noshowed",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.noshowed',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.noshowed',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.noshowed', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.noshowed', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.noshowed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.noshowed", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.noshowed

Body parameter

{
  "action": "reservation.noshowed",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationNoShowedEvent false none

Responses

Status Meaning Description Schema

post_reservation.assignedtospot

Code samples

# You can also use wget
curl -X POST /reservation.assignedtospot \
  -H 'Content-Type: application/json'

POST /reservation.assignedtospot HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.assignedtospot",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.assignedtospot',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.assignedtospot',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.assignedtospot', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.assignedtospot', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.assignedtospot");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.assignedtospot", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.assignedtospot

Body parameter

{
  "action": "reservation.assignedtospot",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationAssignedToSpotEvent false none

Responses

Status Meaning Description Schema

post_reservation.guestconverted

Code samples

# You can also use wget
curl -X POST /reservation.guestconverted \
  -H 'Content-Type: application/json'

POST /reservation.guestconverted HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.guestconverted",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.guestconverted',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.guestconverted',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.guestconverted', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.guestconverted', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.guestconverted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.guestconverted", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.guestconverted

Body parameter

{
  "action": "reservation.guestconverted",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationGuestConvertedEvent false none

Responses

Status Meaning Description Schema

post_reservation.guestunconverted

Code samples

# You can also use wget
curl -X POST /reservation.guestunconverted \
  -H 'Content-Type: application/json'

POST /reservation.guestunconverted HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.guestunconverted",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.guestunconverted',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.guestunconverted',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.guestunconverted', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.guestunconverted', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.guestunconverted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.guestunconverted", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.guestunconverted

Body parameter

{
  "action": "reservation.guestunconverted",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationGuestUnconvertedEvent false none

Responses

Status Meaning Description Schema

post_reservation.spotswapped

Code samples

# You can also use wget
curl -X POST /reservation.spotswapped \
  -H 'Content-Type: application/json'

POST /reservation.spotswapped HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.spotswapped",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.spotswapped',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.spotswapped',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.spotswapped', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.spotswapped', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.spotswapped");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.spotswapped", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.spotswapped

Body parameter

{
  "action": "reservation.spotswapped",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationSpotSwappedEvent false none

Responses

Status Meaning Description Schema

post_reservation.movedtostandby

Code samples

# You can also use wget
curl -X POST /reservation.movedtostandby \
  -H 'Content-Type: application/json'

POST /reservation.movedtostandby HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "reservation.movedtostandby",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/reservation.movedtostandby',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/reservation.movedtostandby',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/reservation.movedtostandby', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/reservation.movedtostandby', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/reservation.movedtostandby");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/reservation.movedtostandby", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST reservation.movedtostandby

Body parameter

{
  "action": "reservation.movedtostandby",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ReservationMovedToStandbyEvent false none

Responses

Status Meaning Description Schema

Class Session

Receive updates when class sessions are created and updated (this includes any availability changes).

post_class_session.created

Code samples

# You can also use wget
curl -X POST /class_session.created \
  -H 'Content-Type: application/json'

POST /class_session.created HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "class_session.created",
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/class_session.created',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/class_session.created',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/class_session.created', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/class_session.created', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/class_session.created");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/class_session.created", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST class_session.created

Body parameter

{
  "action": "class_session.created",
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ClassSessionCreatedEvent false none

Responses

Status Meaning Description Schema

post_class_session.updated

Code samples

# You can also use wget
curl -X POST /class_session.updated \
  -H 'Content-Type: application/json'

POST /class_session.updated HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "class_session.updated",
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/class_session.updated',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/class_session.updated',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/class_session.updated', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/class_session.updated', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/class_session.updated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/class_session.updated", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST class_session.updated

Body parameter

{
  "action": "class_session.updated",
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body ClassSessionUpdatedEvent false none

Responses

Status Meaning Description Schema

Order

Receive updates when orders are created and refunded.

post_order.completed

Code samples

# You can also use wget
curl -X POST /order.completed \
  -H 'Content-Type: application/json'

POST /order.completed HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "order.completed",
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/order.completed',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/order.completed',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/order.completed', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/order.completed', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/order.completed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/order.completed", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST order.completed

Body parameter

{
  "action": "order.completed",
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body OrderCompletedEvent false none

Responses

Status Meaning Description Schema

post_order.refunded

Code samples

# You can also use wget
curl -X POST /order.refunded \
  -H 'Content-Type: application/json'

POST /order.refunded HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "order.refunded",
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/order.refunded',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/order.refunded',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/order.refunded', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/order.refunded', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/order.refunded");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/order.refunded", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST order.refunded

Body parameter

{
  "action": "order.refunded",
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body OrderRefundedEvent false none

Responses

Status Meaning Description Schema

Membership

Receive updates when memberships are activated and deactivated.

post_membership.activated

Code samples

# You can also use wget
curl -X POST /membership.activated \
  -H 'Content-Type: application/json'

POST /membership.activated HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "membership.activated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/membership.activated',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/membership.activated',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/membership.activated', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/membership.activated', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/membership.activated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/membership.activated", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST membership.activated

Body parameter

{
  "action": "membership.activated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body MembershipActivatedEvent false none

Responses

Status Meaning Description Schema

post_membership.deactivated

Code samples

# You can also use wget
curl -X POST /membership.deactivated \
  -H 'Content-Type: application/json'

POST /membership.deactivated HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "membership.deactivated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/membership.deactivated',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/membership.deactivated',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/membership.deactivated', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/membership.deactivated', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/membership.deactivated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/membership.deactivated", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST membership.deactivated

Body parameter

{
  "action": "membership.deactivated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body MembershipDeactivatedEvent false none

Responses

Status Meaning Description Schema

post_membership.suspended

Code samples

# You can also use wget
curl -X POST /membership.suspended \
  -H 'Content-Type: application/json'

POST /membership.suspended HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "action": "membership.deactivated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/membership.suspended',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post '/membership.suspended',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/membership.suspended', headers = headers)

print(r.json())

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/membership.suspended', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/membership.suspended");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/membership.suspended", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST membership.suspended

Body parameter

{
  "action": "membership.deactivated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Parameters

Name In Type Required Description
body body MembershipDeactivatedEvent false none

Responses

Status Meaning Description Schema

Schemas

Location

{
  "id": "48717",
  "type": "location",
  "name": "Location swAyUrwCZhDL",
  "timezone": "US/Pacific",
  "region": {
    "id": "48541",
    "type": "region",
    "name": "Region JIpHfuOIJXDD"
  }
}

Properties

Name Type Required Restrictions Description
id string false none none
type string false none none
name string false none none
timezone string false none none
region object false none none
» id string false none none
» type string false none none
» name string false none none

Profile

{
  "id": "35077",
  "type": "profile",
  "address_line1": "7509 Highway St",
  "address_line2": "Suite 624",
  "address_line3": "Barra",
  "address_sorting_code": "3",
  "birth_date": "1934-07-16",
  "city": "North Sandra",
  "company_name": "Boone-Turner",
  "country": "US",
  "created_datetime": "2018-11-23T13:09:26Z",
  "email": "cheryl.clark.59@marianatek.com",
  "emergency_contact_email": "robertjones@example.org",
  "emergency_contact_name": "Allison Snyder",
  "emergency_contact_phone": "+45(0)6974305901",
  "emergency_contact_relationship": "aunt",
  "first_name": "Cheryl",
  "formatted_address": [
    "1234 Main Street",
    "Washington, DC 20003",
    "United States"
  ],
  "full_name": "Cheryl Clark",
  "gender": "non_binary",
  "home_location": {
    "id": "48717",
    "type": "location",
    "name": "Location swAyUrwCZhDL",
    "timezone": "US/Pacific",
    "region": {
      "id": "48541",
      "type": "region",
      "name": "Region JIpHfuOIJXDD"
    }
  },
  "is_opted_in_to_marketing": true,
  "is_opted_in_to_sms": true,
  "last_name": "Clark",
  "phone_number": "1-273-679-3099x545",
  "postal_code": 5941,
  "pronouns": "they/them",
  "state_province": "MS",
  "customer_locations": [
    {
      "context": "home_location",
      "event_datetime": "2018-11-23T13:09:26Z",
      "location_id": "12345"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string false none none
type string false none none
address_line1 string false none none
address_line2 string false none none
address_line3 string false none Neighborhood, or other "dependent locality" in countries such as New Zealand or Brazil
address_sorting_code string false none Sorting Code used in addresses for some countries, such as "Lilongwe 3"
birth_date string(date) false none none
city string false none none
company_name string false none none
country string false none none
created_datetime string(date-time) false none none
email string false none none
emergency_contact_email string false none none
emergency_contact_name string false none none
emergency_contact_phone string false none none
emergency_contact_relationship string false none none
first_name string false none none
formatted_address array(string) false none List containing pieces of address information grouped, or separated, according to the expectations for that country
full_name string false none none
gender string false none none
home_location Location false none none
is_opted_in_to_marketing boolean false none none
is_opted_in_to_sms boolean false none none
last_name string false none none
phone_number string false none none
postal_code string false none none
pronouns string false none none
state_province string false none none
customer_locations [object] false none none
» context string false none none
» event_datetime string(date-time) false none none
» location_id string false none none

ClassSession

{
  "id": 6573,
  "type": "class_session",
  "available_spots": 20,
  "cancellation_datetime": "2019-04-17T12:00:00-07:00",
  "class_type": {
    "id": 5889,
    "type": "class_type",
    "duration": 57,
    "is_live_stream": true,
    "name": "Class Session Type IXHooDJEIkfJ"
  },
  "class_name": "Special Class",
  "classroom_name": "SteelBlue",
  "capacity": 10,
  "direct_booking_currency_code": "USD",
  "direct_booking_price": 25,
  "direct_booking_reservation_limit": 5,
  "end_datetime": "2019-04-16T12:57:00-07:00",
  "instructors": [
    {
      "id": 6106,
      "type": "instructor",
      "name": "Amy F"
    }
  ],
  "layout_format": "first-come-first-serve",
  "live_stream_url": "https://live-stream-class-url.com",
  "location": {
    "id": "48717",
    "type": "location",
    "name": "Location swAyUrwCZhDL",
    "timezone": "US/Pacific",
    "region": {
      "id": "48541",
      "type": "region",
      "name": "Region JIpHfuOIJXDD"
    }
  },
  "start_date": "2019-04-16",
  "start_datetime": "2019-04-16T12:00:00-07:00",
  "start_time": "12:00:00"
}

Properties

Name Type Required Restrictions Description
id string false none none
type string false none none
available_spots integer(int32) false none none
cancellation_datetime string(date-time) false none none
class_type object false none none
» id string false none none
» type string false none none
» duration integer(int32) false none none
» is_live_stream boolean false none none
» name string false none none
class_name string false none none
classroom_name string false none none
capacity integer(int32) false none none
direct_booking_currency_code string false none none
direct_booking_price string false none none
direct_booking_reservation_limit string false none none
end_datetime string(date-time) false none none
instructors [object] false none none
» id string false none none
» type string false none none
» name string false none none
layout_format string false none none
live_stream_url url false none none
location Location false none none
start_date string(date) false none none
start_datetime string(date-time) false none none
start_time string false none none

ProfileCreatedEvent

{
  "action": "profile.created",
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ProfileUpdatedEvent

{
  "action": "profile.updated",
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ClassSessionCreatedEvent

{
  "action": "class_session.created",
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ClassSessionUpdatedEvent

{
  "action": "class_session.updated",
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationCreatedEvent

{
  "action": "reservation.created",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationCheckedInEvent

{
  "action": "reservation.checkedin",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationCheckedOutEvent

{
  "action": "reservation.checkedout",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationCancelledEvent

{
  "action": "reservation.cancelled",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationNoShowedEvent

{
  "action": "reservation.noshowed",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationAssignedToSpotEvent

{
  "action": "reservation.assignedtospot",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationGuestConvertedEvent

{
  "action": "reservation.guestconverted",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationGuestUnconvertedEvent

{
  "action": "reservation.guestunconverted",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationSpotSwappedEvent

{
  "action": "reservation.spotswapped",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

ReservationMovedToStandbyEvent

{
  "action": "reservation.movedtostandby",
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

OrderCompletedEvent

{
  "action": "order.completed",
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

OrderRefundedEvent

{
  "action": "order.refunded",
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

MembershipActivatedEvent

{
  "action": "membership.activated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

MembershipDeactivatedEvent

{
  "action": "membership.deactivated",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

MembershipSuspendedEvent

{
  "action": "membership.suspended",
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
action string false none none

WebhookWrapper

{
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
tenant string false none none
event_datetime string(date-time) false none none

WebhookProfile

{
  "profile": {
    "id": "35077",
    "type": "profile",
    "address_line1": "7509 Highway St",
    "address_line2": "Suite 624",
    "address_line3": "Barra",
    "address_sorting_code": "3",
    "birth_date": "1934-07-16",
    "city": "North Sandra",
    "company_name": "Boone-Turner",
    "country": "US",
    "created_datetime": "2018-11-23T13:09:26Z",
    "email": "cheryl.clark.59@marianatek.com",
    "emergency_contact_email": "robertjones@example.org",
    "emergency_contact_name": "Allison Snyder",
    "emergency_contact_phone": "+45(0)6974305901",
    "emergency_contact_relationship": "aunt",
    "first_name": "Cheryl",
    "formatted_address": [
      "1234 Main Street",
      "Washington, DC 20003",
      "United States"
    ],
    "full_name": "Cheryl Clark",
    "gender": "non_binary",
    "home_location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "is_opted_in_to_marketing": true,
    "is_opted_in_to_sms": true,
    "last_name": "Clark",
    "phone_number": "1-273-679-3099x545",
    "postal_code": 5941,
    "pronouns": "they/them",
    "state_province": "MS",
    "customer_locations": [
      {
        "context": "home_location",
        "event_datetime": "2018-11-23T13:09:26Z",
        "location_id": "12345"
      }
    ]
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
profile Profile false none none

WebhookClassSession

{
  "class_session": {
    "id": 6573,
    "type": "class_session",
    "available_spots": 20,
    "cancellation_datetime": "2019-04-17T12:00:00-07:00",
    "class_type": {
      "id": 5889,
      "type": "class_type",
      "duration": 57,
      "is_live_stream": true,
      "name": "Class Session Type IXHooDJEIkfJ"
    },
    "class_name": "Special Class",
    "classroom_name": "SteelBlue",
    "capacity": 10,
    "direct_booking_currency_code": "USD",
    "direct_booking_price": 25,
    "direct_booking_reservation_limit": 5,
    "end_datetime": "2019-04-16T12:57:00-07:00",
    "instructors": [
      {
        "id": 6106,
        "type": "instructor",
        "name": "Amy F"
      }
    ],
    "layout_format": "first-come-first-serve",
    "live_stream_url": "https://live-stream-class-url.com",
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "start_date": "2019-04-16",
    "start_datetime": "2019-04-16T12:00:00-07:00",
    "start_time": "12:00:00"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
class_session ClassSession false none none

WebhookReservation

{
  "reservation": {
    "id": 2606,
    "type": "reservation",
    "class_session": {
      "id": 6573,
      "type": "class_session",
      "available_spots": 20,
      "cancellation_datetime": "2019-04-17T12:00:00-07:00",
      "class_type": {
        "id": 5889,
        "type": "class_type",
        "duration": 57,
        "is_live_stream": true,
        "name": "Class Session Type IXHooDJEIkfJ"
      },
      "class_name": "Special Class",
      "classroom_name": "SteelBlue",
      "capacity": 10,
      "direct_booking_currency_code": "USD",
      "direct_booking_price": 25,
      "direct_booking_reservation_limit": 5,
      "end_datetime": "2019-04-16T12:57:00-07:00",
      "instructors": [
        {
          "id": 6106,
          "type": "instructor",
          "name": "Amy F"
        }
      ],
      "layout_format": "first-come-first-serve",
      "live_stream_url": "https://live-stream-class-url.com",
      "location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "start_date": "2019-04-16",
      "start_datetime": "2019-04-16T12:00:00-07:00",
      "start_time": "12:00:00"
    },
    "credit_payments": [
      {
        "expiration_date": "2019-04-19T22:33:58.630439Z",
        "is_expired": true,
        "name": "Credit oRQxQeTGvAFw",
        "package_name": "string",
        "package_source": "purchase",
        "remaining": 4
      }
    ],
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "guest_email": "string",
    "membership_payments": [
      {
        "contract_name": "string",
        "end_date": "string",
        "name": "Membership XTExfoWwDDog",
        "remaining_renewals": "string"
      }
    ],
    "payer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "reservation_type": "standard",
    "spot": "string",
    "status": "pending"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
reservation object false none none
» id string false none none
» type string false none none
» class_session ClassSession false none none
» credit_payments [object] false none none
»» expiration_date date-time false none none
»» is_expired boolean false none none
»» name string false none none
»» package_name string(nullable) false none none
»» package_source string false none none
»» remaining integer(int32) false none none
» customer Profile false none none
» guest_email string(nullable) false none none
» membership_payments [object] false none none
»» contract_name string(nullable) false none none
»» end_date string(nullable) false none none
»» name string false none none
»» remaining_renewals string(nullable) false none none
» payer Profile false none none
» reservation_type string false none none
» spot string(nullable) false none none
» status string false none none

WebhookOrder

{
  "order": {
    "id": 1463,
    "type": "order",
    "currency": "USD",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "discount_total": 0,
    "discounts": [
      {
        "name": "Promo",
        "amount": 50.25
      }
    ],
    "location": {
      "id": "48717",
      "type": "location",
      "name": "Location swAyUrwCZhDL",
      "timezone": "US/Pacific",
      "region": {
        "id": "48541",
        "type": "region",
        "name": "Region JIpHfuOIJXDD"
      }
    },
    "number": "HB53-SK6N-42XC",
    "order_datetime": "2019-04-16T16:33:51.367697Z",
    "order_lines": [
      {
        "id": 1515,
        "type": "order_line",
        "line_subtotal": 50.25,
        "line_total": 50.25,
        "options": [
          {
            "name": "Note",
            "value": "Happy Birthday!"
          }
        ],
        "product": {
          "id": 14688,
          "type": "product",
          "name": "Product DAsraIsKanxr"
        },
        "quantity": 1,
        "status": "Completed",
        "unit_subtotal": 50.25,
        "unit_total": 50.25
      }
    ],
    "payment_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_sources": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "refund_total": 0,
    "status": "Completed",
    "subtotal": 50.25,
    "tax_total": 0,
    "taxes": [
      {
        "name": "Cash",
        "amount": 50.25
      }
    ],
    "total": 50.25
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
order object false none none
» id string false none none
» type string false none none
» currency string false none none
» customer Profile false none none
» discount_total string false none none
» discounts [object] false none none
»» name string false none none
»» amount string false none none
» location Location false none none
» number string false none none
» order_datetime string false none none
» order_lines [object] false none none
»» id string false none none
»» type string false none none
»» line_subtotal string false none none
»» line_total string false none none
»» options [object] false none none
»»» name string false none none
»»» value string false none none
»» product object false none none
»»» id string false none none
»»» type string false none none
»»» name string false none none
»» quantity integer(int32) false none none
»» status string false none none
»» unit_subtotal string false none none
»» unit_total string false none none
» payment_sources [object] false none none
»» name string false none none
»» amount string false none none
» refund_sources [object] false none none
»» name string false none none
»» amount string false none none
» refund_total string false none none
» status string false none none
» subtotal string false none none
» tax_total string false none none
» taxes [object] false none none
»» name string false none none
»» amount string false none none
» total string false none none

WebhookMembership

{
  "membership": {
    "id": 1463,
    "type": "membership",
    "customer": {
      "id": "35077",
      "type": "profile",
      "address_line1": "7509 Highway St",
      "address_line2": "Suite 624",
      "address_line3": "Barra",
      "address_sorting_code": "3",
      "birth_date": "1934-07-16",
      "city": "North Sandra",
      "company_name": "Boone-Turner",
      "country": "US",
      "created_datetime": "2018-11-23T13:09:26Z",
      "email": "cheryl.clark.59@marianatek.com",
      "emergency_contact_email": "robertjones@example.org",
      "emergency_contact_name": "Allison Snyder",
      "emergency_contact_phone": "+45(0)6974305901",
      "emergency_contact_relationship": "aunt",
      "first_name": "Cheryl",
      "formatted_address": [
        "1234 Main Street",
        "Washington, DC 20003",
        "United States"
      ],
      "full_name": "Cheryl Clark",
      "gender": "non_binary",
      "home_location": {
        "id": "48717",
        "type": "location",
        "name": "Location swAyUrwCZhDL",
        "timezone": "US/Pacific",
        "region": {
          "id": "48541",
          "type": "region",
          "name": "Region JIpHfuOIJXDD"
        }
      },
      "is_opted_in_to_marketing": true,
      "is_opted_in_to_sms": true,
      "last_name": "Clark",
      "phone_number": "1-273-679-3099x545",
      "postal_code": 5941,
      "pronouns": "they/them",
      "state_province": "MS",
      "customer_locations": [
        {
          "context": "home_location",
          "event_datetime": "2018-11-23T13:09:26Z",
          "location_id": "12345"
        }
      ]
    },
    "end_date": "2030-01-01",
    "freeze_start_date": "2023-05-26",
    "freeze_end_date": "2023-05-26",
    "is_charge_declined": false,
    "name": "Classic Membership",
    "purchase_date": "2020-01-01",
    "purchase_location": "Dupont Circle",
    "start_date": "2020-01-01",
    "status": "active"
  },
  "tenant": "cool_yoga",
  "event_datetime": "2019-04-14T18:49:53.438830Z"
}

Properties

Name Type Required Restrictions Description
membership object false none none
» id string false none none
» type string false none none
» customer Profile false none none
» end_date string(date) false none The date this membership ends and becomes unusable.
» freeze_start_date string(date) false none The start date of any active or pending freeze on this membership.
» freeze_end_date string(date) false none The end date of any active or pending freeze on this membership.
» is_charge_declined boolean false none Whether this membership is currently suspended due to a declined charge.
» name string false none The name of this membership.
» purchase_date string(date) false none The date this membership was initially purchased. This value always reflects the first payment and does not change after each renewal.
» purchase_location string false none The name of the location where this membership was purchased.
» start_date string(date) false none The date that this membership first became active.
» status string false none The current status of this membership. Options are "active", "frozen", "cancelled", "terminated", "payment_failure", "ding_failure", "done", "pending_customer_activation", and "pending_start_date".