| Required role: | Business |
| POST | /staff/invite |
|---|
"use strict";
/** @typedef {'Owner'|'Manager'|'Sales'|'Marketing'|'Other'} */
export var BusinessRole;
(function (BusinessRole) {
BusinessRole["Owner"] = "Owner"
BusinessRole["Manager"] = "Manager"
BusinessRole["Sales"] = "Sales"
BusinessRole["Marketing"] = "Marketing"
BusinessRole["Other"] = "Other"
})(BusinessRole || (BusinessRole = {}));
JavaScript InviteStaffRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /staff/invite HTTP/1.1
Host: business-api.brovs.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<InviteStaffRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
<BusinessId>0</BusinessId>
<BusinessRole>Owner</BusinessRole>
<PlaceId>0</PlaceId>
<Role>Owner</Role>
<UserId>0</UserId>
</InviteStaffRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InviteStaffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
<SentEmailWithRequestId>String</SentEmailWithRequestId>
<StaffInvitation>
<BusinessId>0</BusinessId>
<BusinessName>String</BusinessName>
<BusinessRole>Owner</BusinessRole>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<FirstName>String</FirstName>
<Id>0</Id>
<InviteKey>String</InviteKey>
<LastName>String</LastName>
<PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
<PlaceId>0</PlaceId>
<PlaceName>String</PlaceName>
<Role>Owner</Role>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UserId>0</UserId>
</StaffInvitation>
</InviteStaffResponse>