Delete Avatar Image

Delete an existing image in an avatar profile by image_id.

Delete Avatar Image API Documentation

The DELETE /v1/avatar-profiles/{avatar_id}/images/{image_id} endpoint deletes the specified image with image_id related to the avatar profile with the avatar_id. The request may fail with a 409 resource_conflict error code if you try to delete the base image, i.e., image_id is same as base_image_id of the avatar profile.

API Request

Sending Request

bash
curl -X DELETE "https://api.zoice.com/v1/avatar-profiles/b92d8dd4-f3fa-4624.../images/img_foOVf4w78L6...." \
  -H "Authorization: Bearer $ZOICE_API_KEY"

Response Format

json
{
	"status": "success"
}

Schema

Input

Path Parameter

Type

Required

Default

Range

avatar_id

string

Yes

-

a valid UUID string

image_id

string

Yes

-

a valid image ID string

Output

Field

Type

Description

status

string

The status of the API request.

Allowed values: "success", "failed"