Register a guest on Gympass

Purpose: The purpose of this API is to register your guests on external providers like Gympass.

You must provide the unique identifier of the external service provider in provider_id. The API will then register the guest on Gympass.

user Object

NameTypeDescription
personal_infoobjectThis object contains the personal information of the guest.
user_namestringUsername of the guest as mentioned in Gympass.
first_namestringFirst name of the guest.
last_namestringLast name of the guest.
middle_namestringMiddle name of the guest.
emailstringEmail id of the guest.
phone_codeintegerPhone code of the country.
numberstringPrimary phone number of the guest.
genderenumIndicates the gender of the guest.
-1 = Not specified,
1 = Male,
0 = Female,
3 = Others
work_phonestringWork phone number of the guest.
home_phonestringHome phone number of the guest.
date_of_birthdateThe date of birth of the guest.
anniversary_datedateDate and time of the guest's anniversary.
address_1stringPrimary address of the guest.
address_2stringSecondary address of the guest.
citystringCity to which the guest belongs.
state_idintegerID of the state to which the guest belongs.
For more information on how to fetch the state IDs of a specific country, refer to the Retrieve the list of all states of a country API.
zip_codeintegerZip code of the guest's address.
country_idintegerID of the country to which the guest belongs. For example, the country_id of United States of America is 225.
You can use the Retrieve the list of all countries API to fetch country codes (id) and each country's corresponding phone code (phone_code).
Language
Authorization
Header
Click Try It! to start a request and see the response here!