/facepop/edit Endpoint

This endpoint allows you to update an existing facepop by providing the modified facepop object. All desired changes should be included in the request.

Endpoint Details

Request

POST /facepop/edit

This endpoint requires a POST request with your API key and the complete facepop object containing all desired modifications.

Parameters

Required Parameters:

APIKey

Your unique API key to authenticate the request.

facepop

The complete facepop object with all modifications. Make sure to include all required fields, including the facepop ID to identify which facepop to update.

Note: You must include all fields you wish to keep in the facepop object, not just the ones you want to change. Any fields not included will be removed from the facepop.

Response

Status: 200 OK

The endpoint returns a 200 OK status code on successful operation.

Success Response Body:

{
  "success": true,
  "data": {
    ... your edited facepop
  }
}

Error Response (if facepop not found):

{
  "success": false,
  "data": "The requested facepop does not exist or you don't have permission to edit it"
}

This error occurs when the facepop ID provided doesn't exist in your account or you don't have access to edit it.

Example Request

Using cURL:

curl -X POST https://api.answerly.io/facepop/edit \
  -H "Content-Type: application/json" \
  -d '{
    "APIKey": "your-api-key-here",
    "facepop": {
      ... your facepop object
    }
  }'

Important Notes

Complete Object Required

When editing a facepop, you must provide the complete facepop object with all fields you want to keep, not just the fields you want to change. Any fields omitted from the request will be removed from the facepop.

Identification

The facepop object must include the id field to identify which facepop should be updated. Without this, the system won't know which facepop to modify.

Error Handling

If the facepop ID doesn't exist or you don't have permission to edit it, the API will return an error response with a detailed message. Always check the success field in the response to confirm if the operation succeeded.

Documentation Menu