ConsumerApi

<back to all web services

ReferFriendLinkRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/share/refer-friend-linkCreate a friend referral linkThe link contains a JWT token with the identity of the referring user as well as the expiration of the referral.
"use strict";
export class ReferFriendLinkResponse {
    /** @param {{linkWithReferFriendToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    linkWithReferFriendToken;
}
export class ReferFriendLinkRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ReferFriendLinkRequest DTOs

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.

GET /share/refer-friend-link HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"linkWithReferFriendToken":"String"}