Create New FacePop
This endpoint allows you to create a new FacePop in the system.
Endpoint Details
Request
POST /facepop/new
This endpoint requires a POST request with your API key and a complete facepop object.
Parameters
Required Parameters:
APIKey
Your unique API key to authenticate the request.
facepop
A complete facepop object matching the schema from /facepop-objects documentation.
Note: The 'facepop' key must contain a complete facepop object. No other parameters are required in the request body.
Response
Status: 200 OK
The endpoint always returns a 200 OK status code with a JSON response.
Success Response Body:
{
"status": true,
"data": {
"id": "server_generated_id",
// The complete facepop object you created with its new ID
}
}
Error Response:
{
"status": false,
"data": "This FacePop was not found in your account"
}
Various error messages may be returned based on the specific issue encountered.
Example Request
Using cURL:
curl -X POST https://api.answerly.io/facepop/new \
-H "Content-Type: application/json" \
-d '{
"APIKey": "your_api_key_here",
"facepop": {
// Your complete facepop object matching the schema
}
}'
Important Notes
Server-Generated ID
The newly created facepop will have an ID generated by the server. This response is where you'll get the ID of your new facepop for the first time. Make sure to store this ID as you'll need it for future operations on this facepop.
Complete Object Required
When creating a facepop, you must provide a complete facepop object that matches the schema described in the facepop-object documentation. All required fields must be included in your request.
Error Handling
Always check the status field in the response to confirm if the operation succeeded. If the status is false, the data field will contain an error message explaining what went wrong.