Delete Photo Avatar Group

DELETEhttps://api.konpro.ai/v1/photo_avatar_group/{avatar_group_id}

Permanently delete a photo avatar group and all associated avatars by specifying the group's unique identifier.

Request History

TIME	STATUS	USER AGENT
Make a request to see history.

0 Requests This Month

cURL Request

shell

curl --request DELETE \
--url https://api.konpro.ai/v1/photo_avatar_group/<avatar_group_id> \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

Path Parameter

Parameter	Type	Description
avatar_group_id	string	Unique identifier of the photo avatar group to delete (required)

Response

Response Structure

Confirms the successful deletion of the avatar group. Returns error details if deletion is unsuccessful.

Sample Successful Response

json

{
  "group_id": "group123",
  "status": "deleted",
  "message": "Photo avatar group and all associated avatars successfully deleted",
  "deleted_avatars_count": 5,
  "deleted_at": "2024-01-15T13:30:00Z"
}

Notes

Requires API authentication.
The avatar_group_id must reference an existing photo avatar group.
This action cannot be undone - the group and all avatars will be permanently deleted.
All associated avatars, motion data, sound effects, and metadata will be removed.
Deletion is immediate and irreversible.
Use with extreme caution as this action is destructive and affects multiple avatars.
Refer to Error Responses for error information.

Example Usage

Shell

curl --request DELETE \
--url https://api.konpro.ai/v1/photo_avatar_group/<avatar_group_id> \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

LANGUAGE

CREDENTIALS

Header

HEADER

RESPONSE

Examples

Choose an example:

application/json

200 - Success

400 - Bad Request

Delete Photo Avatar List Brand Voices