Whitelabel

/whitelabel-client-invitation-create

Published @ 11/02/2026 by

Fatos, Founder @ answerly.io

POST https://api.answerly.io/whitelabel-client-invitation-create

Gives you an invitation link for a whitelabel client with a pre-configured plan.

Request Body

APIKey string Required

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

name string Required

The specific action name. Must be exactly:
whitelabel-client-invitation-create

input object Required

The container for the invitation details. See keys below.

input.email string Required

The email address of the client you wish to invite.

input.companyId string Required

The ID of your company.

You can find the Company ID in the same page where you create an API key.

input.whitelabelId string Required

The ID of your whitelabel instance.

You can find the Whitelabel ID in the same page where you create an API key.

input.planIds array Required

An array of objects defining which products and plans to assign.

input.planIds[].productName string Required

The product to assign. Allowed values:
Chatbot, FacePop, PopupHero, Banner, WonderForm, Feedlo, Survia, Websito

input.planIds[].planId string Required

The specific Plan ID for that product.

You can find the Plan IDs in the plan manager at your whitelabel dashboard.

curl --request POST \
    --url 'https://api.answerly.io/whitelabel-client-invitation-create' \
    --header 'Content-Type: application/json' \
    --data '{
        "APIKey": "YOUR_API_KEY",
        "name": "whitelabel-client-invitation-create",
        "input": {
            "email": "client@example.com",
            "companyId": "cmp_12345",
            "whitelabelId": "wl_67890",
            "planIds": [
                {
                    "productName": "Chatbot",
                    "planId": "Chatbot-pro_whitelabel"
                },
                {
                    "productName": "FacePop",
                    "planId": "FacePop-free"
                }
            ]
        }
    }'

Return (success)

taskName string

The name of the executed task.

error boolean

Indicates if the request failed. Returns false for success.

output string

The invitation URL string.

{
    "error": false,
    "taskName": "whitelabel-client-invitation-create",
    "output": "https://app.your-whitelabel.io/signup?invitation-token=..."
}

Return (failure)

taskName string

The name of the executed task.

error boolean

Indicates if the request failed. Returns true for failure.

code string

An error code returned by the server. Possible values:
WHITELABEL_NOT_FOUND
WHITELABEL_HOSTNAME_NOT_CONFIGURED
PLAN_NOT_FOUND
USER_ALREADY_EXISTS
PRODUCT_DISABLED

message string

A human-readable message providing more details about the error.

detail string

Additional details about the error, if available.

{
    "taskName": "whitelabel-client-invitation-create",
    "error": true,
    "code": "WHITELABEL_NOT_FOUND",
    "message": "The specified whitelabel instance was not found.",
    "detail": "Additional details about the error, if available."
}