curl -X DELETE "https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78" \
-H "x-api-key: your_api_key_here"
const response = await fetch("https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78", {
method: "DELETE",
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
const { data } = await response.json();
import os
import requests
response = requests.delete(
"https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
data = response.json()["data"]
{
"success": true,
"message": "Character deleted",
"data": {
"characterId": "cm4xa1b2c0001cd34ef56gh78",
"deleted": true,
"projectsUsing": 2
}
}
{
"success": false,
"message": "Character not found"
}
Resources
Delete Character
Delete a Cinematic character for good
DELETE
/
v1
/
character
/
{characterId}
curl -X DELETE "https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78" \
-H "x-api-key: your_api_key_here"
const response = await fetch("https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78", {
method: "DELETE",
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
const { data } = await response.json();
import os
import requests
response = requests.delete(
"https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
data = response.json()["data"]
{
"success": true,
"message": "Character deleted",
"data": {
"characterId": "cm4xa1b2c0001cd34ef56gh78",
"deleted": true,
"projectsUsing": 2
}
}
{
"success": false,
"message": "Character not found"
}
Overview
Deletes one of your team’s characters, the same as Delete in Studio → Characters.This cannot be undone. Get Character answers
404 for it from then on, and it leaves List Characters.- Cinematic projects that cast the character keep their own copy of the cast, so they keep working.
projectsUsingsays how many there are (the number the dashboard warns with). - Its photos stay in your media library. Delete them with Delete Media if you no longer need them.
- A portrait still being generated finishes into your library and its credits are not given back.
curl -X DELETE "https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78" \
-H "x-api-key: your_api_key_here"
const response = await fetch("https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78", {
method: "DELETE",
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
const { data } = await response.json();
import os
import requests
response = requests.delete(
"https://api.hooked.so/v1/character/cm4xa1b2c0001cd34ef56gh78",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
data = response.json()["data"]
{
"success": true,
"message": "Character deleted",
"data": {
"characterId": "cm4xa1b2c0001cd34ef56gh78",
"deleted": true,
"projectsUsing": 2
}
}
{
"success": false,
"message": "Character not found"
}
Errors
| Status | When |
|---|---|
| 401 | Missing or invalid API key (code: "not_authenticated") |
| 403 | The team does not have the Hooked app product (code: "entitlement_required") |
| 404 | No such character in your team, including one already deleted. Another team’s character, or an id that is not one, answers the same Character not found |