BusinessApi

<back to all web services

InviteStaffRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/staff/invite
InviteStaffRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdbodylongNo
PlaceIdbodylong?No
BusinessIdbodylong?No
RolebodyStaffRoleNo
BusinessRolebodyBusinessRoleNo
StaffRole Enum:
Owner
Admin
Regular
BusinessRole Enum:
Owner
Manager
Sales
Marketing
Other
InviteStaffResponse Parameters:
NameParameterData TypeRequiredDescription
StaffInvitationformStaffInvitationDtoYes
SentEmailWithRequestIdformstringYes
StaffInvitationDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UserIdformlong?No
PlaceIdformlong?No
PlaceGuidformGuid?No
InviteKeyformstringYes
BusinessIdformlong?No
FirstNameformstringNo
LastNameformstringNo
PlaceNameformstringNo
BusinessNameformstringNo
RoleformStaffRoleNo
BusinessRoleformBusinessRoleNo
CreatedAtformDateTimeNo
UpdatedAtformDateTimeNo

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"userId":0,"placeId":0,"businessId":0,"role":"Owner","businessRole":"Owner"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"staffInvitation":{"id":0,"userId":0,"placeId":0,"placeGuid":"00000000-0000-0000-0000-000000000000","inviteKey":"String","businessId":0,"firstName":"String","lastName":"String","placeName":"String","businessName":"String","role":"Owner","businessRole":"Owner","createdAt":"0001-01-01T00:00:00.0000000Z","updatedAt":"0001-01-01T00:00:00.0000000Z"},"sentEmailWithRequestId":"String"}