Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Create a guest

This API helps you to create a guest. To create a new guest, you must fill the available details of the guest along with the mandatory fields that are set in the organization guest settings and then supply that guest object. In return, you will receive the guest object along with the unique identifier of the guest. Refer to the examples to know the minimum and maximum details required to create a guest.

post/v1/guests

Query parameters

expandstring

Guest object supports multiple parameters like tags, referrals, address_info, preferences, and login_info. Pass the required parameters using expand query parameter to include the same in the response.

Request body

RAW_BODYstring json

Response

200

OR

Example response

{
  "id": "7ffbeb62-efd0-435c-b98b-2475c311868b",
  "center_id": "b5ed4fbb-4c05-4195-b313-1320b620224b",
  "personal_info": {
    "first_name": "abcd",
    "last_name": "efgh",
    "mobile_phone": {
      "country_code": 95,
      "number": "7777788888"
    },
    "date_of_birth": "0001-01-01T00:00:00",
    "nationality_id": -1,
    "anniversary_date": "0001-01-01T00:00:00"
  },
  "address_info": {
    "country_id": -1,
    "state_id": -1
  },
  "preferences": {
    "recieve_lp_stmt": true
  }
}