| POST | /club/guest-pass/activate | Activate a guest pass. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| XForwardedFor | header | string | No | IP address of the end user |
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| StoreId | query | integer | Yes | Store ID |
| GuestPassId | query | integer | Yes | Guest pass to activate. |
| Expires | query | datetime | No | When will this pass expire? (leave blank for never) |
| RestrictedId | body | int? | No | |
| RestrictedResourceType | body | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GuestPassId | form | int | No | |
| Expires | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ChainId | form | int? | No | |
| ApiKey | form | string | No | |
| StoreId | form | int? | No |
| Store | |
| Chain | |
| User | |
| Undefined |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /club/guest-pass/activate HTTP/1.1
Host: www.clubready.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"XForwardedFor":"String","ApiKey":"String","StoreId":0,"GuestPassId":0,"Expires":"0001-01-01T00:00:00.0000000","RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Success":false,"Message":"String"}