Delete flow component

Remove a component from the library.

DELETEhttps://api.tried.com.au/delete-conversation-flow-component/{component_id}

Deletes a library component. If flows still use it, the request fails unless you pass force=true.

Request#

Path parameters#

Parameter	Type	Required	Description
`component_id`	string	Yes	The component.

Query parameters#

Parameter	Type	Required	Description
`force`	string	No	`true` deletes even when flows link to the component.

Example request#

curl -X DELETE "https://api.tried.com.au/delete-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f?force=true" \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/delete-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f?force=true", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
console.log(res.status); // 204

import os, requests

res = requests.delete(
    "https://api.tried.com.au/delete-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f?force=true",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
print(res.status_code)

Response#

204 No Content.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `agents` scope.
`404`	The component does not exist.
`409`	Flows use the component and `force` is not `true`. The message lists the flow IDs.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.