API Reference

Add Guest Pass user

post
https://api.zenoti.com/v1/guests//guestpass

Purpose: Use this API to add a new Guest Pass user.
You must specify user_id and the body parameters as mentioned in the BODY PARAMS section.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

error Object

CodeMessageDescription
GP005Guest pass is not enabledWhen Guest Pass feature is not enabled for the business.
GP003Invalid guest membership idWhen an invalid membership_id is passed.
GP002Guest id does not existWhen an invalid guest_id is passed.
GP001Membership expiredWhen the Guest Pass membership of the guest has expired.
Path Params
string
required

Unique identifier of the user.

Body Params
string
required

Unique identifier of the transferring benefit item.

string
required

Type of the item for transferring benefit

string
required

Type of the Guest Pass credit.

string

(optional) Unique identifier of the user

string

First name of the guest

string

Last name of the guest.

string

Email address of the guest.

string

Mobile number of the guest.

Responses

Updated over 3 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago