Skip to content
TriedDocs
Integrations

Update app

Rename an integration app, replace or clear its credentials, or change its action defaults.

PATCHhttps://api.tried.com.au/update-app/{id}

Needs keys Live actions need the vendor's API key or token. Clearing credentials puts the app back in mock mode.

Updates an integration app. Fields you leave out stay as they are. The app type cannot change: create a new app instead.

Request#

Path parameter Type Required Description
id string Yes The app_id.
Field Type Required Description
name string No New display name, 1 to 80 characters.
credentials object or null No Replaces the stored credentials in full. When set, it must hold every key in the type's required_credentials. Pass null to remove them and switch the app to mock mode.
config object No Merged into the existing config key by key. Keys you do not send are kept.

Example request#

curl -X PATCH https://api.tried.com.au/update-app/app_6f1c2a9e4b7d3058a1e2c4f9 \
  -H "Authorization: Bearer $TRIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Melbourne clinic bookings", "config": { "event_type_id": 2097152 } }'
const res = await fetch("https://api.tried.com.au/update-app/app_6f1c2a9e4b7d3058a1e2c4f9", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.TRIED_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ name: "Melbourne clinic bookings", config: { event_type_id: 2097152 } }),
});
const app = await res.json();
import os, requests

res = requests.patch(
    "https://api.tried.com.au/update-app/app_6f1c2a9e4b7d3058a1e2c4f9",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    json={"name": "Melbourne clinic bookings", "config": {"event_type_id": 2097152}},
)
app = res.json()

Response#

200 OK

{
  "app_id": "app_6f1c2a9e4b7d3058a1e2c4f9",
  "app_type": "cal_com",
  "name": "Melbourne clinic bookings",
  "status": "connected",
  "mock": false,
  "credentials": { "api_key": "******7c1e" },
  "required_credentials": ["api_key"],
  "config": { "event_type_id": 2097152 },
  "actions": [
    "cal_com.check_availability",
    "cal_com.book_appointment",
    "cal_com.list_bookings",
    "cal_com.reschedule_booking",
    "cal_com.cancel_booking"
  ],
  "created_timestamp": 1792390000000,
  "last_modification_timestamp": 1792394500000
}

See Create app for the field table.

Errors#

Status When
400 Body fails validation, or credentials lacks a required key, for example zendesk needs subdomain, email, api_token.
401 Missing or invalid API key.
403 The key's IP allowlist or scopes reject the request. This route needs the admin scope. Dashboard users need the admin or developer role.
404 App <id> not found in this workspace.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Same path and method as Retell. The body differs: Tried takes name, credentials and config.