Other
/collab/invite-link
POST
https://registry.api.answerly.io/collab/invite-link
Gives you an invitation link for a collaborator/client.
Request Body
APIKey
string
Required
Your API key. You can read more about how to get an API Key by clicking here.
email
string
Required
The e-mail address of the collaborator.
workspaceName
string
Required
The name of the workspace that you want this collaborator to be part of.
If a workspace with that name is not found, then one will be created.
If a workspace with that name is not found, then one will be created.
hostname
string
Required
Always use
However if you are a whitelabel customer, and would like to use your own hostname in the URL, then provide your hostname in this field.
app.answerly.io if you are unsure.However if you are a whitelabel customer, and would like to use your own hostname in the URL, then provide your hostname in this field.
curl --request POST \
--url 'https://registry.api.answerly.io/collab/invite-link?=' \
--header 'Content-Type: application/json' \
--data '{
"APIKey": "YOUR_API_KEY",
"email": "YOUR_COLLAB_EMAIL",
"workspaceName": "YOUR_WORKSPACE_NAME",
"hostname": "app.answerly.io"
}'
Return (success)
status
boolean
A boolean indicating the success or failure of the request.
data
string
The invitation URL.
{
"status": true,
"data": "https://app.answerly.io/signup/collab?id=???"
}
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": "A user with that e-mail already exists."
}