Skip to content
TriedDocs
Conversation flows

Update flow component

Change a library component.

PATCHhttps://api.tried.com.au/update-conversation-flow-component/{component_id}

Merges the fields you send over the component and increments its version. Flows whose component node has sync: true pick up the change; flows that keep their own copy in components do not.

Request#

Path parameters#

Parameter Type Required Description
component_id string Yes The component.

Body#

Any field of Create flow component, all optional.

Example request#

curl -X PATCH "https://api.tried.com.au/update-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f" \
  -H "Authorization: Bearer $TRIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Collect and confirm callback number"
}'
const res = await fetch("https://api.tried.com.au/update-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.TRIED_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Collect and confirm callback number"
  }),
});
const data = await res.json();
import os, requests

res = requests.patch(
    "https://api.tried.com.au/update-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    json={
        "name": "Collect and confirm callback number",
    },
)
data = res.json()

Response#

200 OK with the updated component.

Errors#

Status When
400 Validation failed.
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.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.