Requires the role: | manager |
POST | /users/invite |
---|
export class PostOperationUnTenanted<TResponse> implements IPost
{
public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class Invitation
{
public firstName?: string;
public lastName?: string;
public email?: string;
public id?: string;
public constructor(init?: Partial<Invitation>) { (Object as any).assign(this, init); }
}
export class InviteGuestResponse
{
public responseStatus?: ResponseStatus;
public invitation?: Invitation;
public constructor(init?: Partial<InviteGuestResponse>) { (Object as any).assign(this, init); }
}
export class InviteGuestRequest extends PostOperationUnTenanted<InviteGuestResponse>
{
public email?: string;
public constructor(init?: Partial<InviteGuestRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript InviteGuestRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"email":"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"}},"invitation":{"firstName":"String","lastName":"String","email":"String","id":"String"}}