Whitelabel

/whitelabel/invite-link

Published @ 27/05/24 by

Fatos, Founder @ answerly.io

POST https://api.answerly.io/whitelabel/invite-link

Gives you an invitation link for a whitelabel client.

Request Body

APIKey string Required

Your API key. You can read more about how to get an API Key by clicking here.

hostname string Required

The hostname of your whitelabel.

inviteData object Required

See below for the keys of the inviteData object.

inviteData.Chatbot string

The plan id of the Chatbot product that you want to invite the user to.

Free ID:
Chatbot-free
Pro ID:
Chatbot-pro_whitelabel

inviteData.FacePop string

The plan id of the FacePop product that you want to invite the user to.

Free ID:
FacePop-free
Whitelabel Pro ID:
FacePop-pro_whitelabel

inviteData.PopupHero string

The plan id of the PopupHero product that you want to invite the user to.

Free ID:
PopupHero-free
Whitelabel Pro ID:
PopupHero-pro_whitelabel

inviteData.WonderForm string

The plan id of the WonderForm product that you want to invite the user to.

Free ID:
WonderForm-free
Whitelabel Pro ID:
WonderForm-pro_whitelabel

inviteData.Banner string

The plan id of the Banner product that you want to invite the user to.

Free ID:
Banner-free
Whitelabel Pro ID:
Banner-pro_whitelabel

curl --request POST \
    --url 'https://api.answerly.io/whitelabel/invite-link?=' \
    --header 'Content-Type: application/json' \
    --data '{
        "APIKey": "YOUR_API_KEY",
        "hostname": "YOUR_WHITE_LABEL_HOSTNAME",
        "inviteData": {
            "Chatbot": "Chatbot-free",
            "FacePop": "FacePop-free",
            "PopupHero": "PopupHero-free",
            "WonderForm": "WonderForm-free",
            "Banner": "Banner-free"
        }
    }'

Return (success)

status boolean

A boolean indicating the success or failure of the request.

data string

The invitation URL.

{
    "status": true,
    "data": "https://app.your-whitelabel.io/signup?..."
}

Return (failure)

status boolean

A boolean indicating the success or failure of the request.

data string

An error message returned by the server.

{
    "status": false,
    "data": "Invalid plan ID."
}