BusinessApi

<back to all web services

InviteStaffRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/staff/invite

export module BusinessApi
{
    // @ts-nocheck

    export enum BusinessRole
    {
        Owner = 'Owner',
        Manager = 'Manager',
        Sales = 'Sales',
        Marketing = 'Marketing',
        Other = 'Other',
    }

}

TypeScript InviteStaffRequest DTOs

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

HTTP + JSV

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

{
	userId: 0,
	placeId: 0,
	businessId: 0,
	role: Owner,
	businessRole: Owner
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		updatedAt: 0001-01-01
	},
	sentEmailWithRequestId: String
}