Billiecart API

<back to all web services

InviteOrganisationMemberRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/organisations/{Id}/members
InviteOrganisationMemberRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
EmailAddressbodystringNo
InviteOrganisationMemberResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
OrganisationformOrganisationNo
Organisation Parameters:
NameParameterData TypeRequiredDescription
DisplayNameformstringNo
OwnersformList<string>No
IsDefaultformbool?No
IdformstringNo
InviteOrganisationMemberResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
OrganisationformOrganisationNo

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

HTTP + CSV

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

POST /organisations/{Id}/members HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","emailAddress":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"organisation":{"displayName":"String","owners":["String"],"isDefault":false,"id":"String"}}