Billiecart API

<back to all web services

InviteGuestRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/users/invite
InviteGuestRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
InviteGuestResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InvitationformInvitationNo
Invitation Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
IdformstringNo
InviteGuestResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InvitationformInvitationNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/invite HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"email":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invitation":{"firstName":"String","lastName":"String","email":"String","id":"String"}}