API reference/Outreach/Dashboards

.md

Delete a dashboard

Deletes a dashboard when the user no longer wants it: its tab leaves the Dashboard. The tables and the activity log do not change.

DELETEhttps://mysdr.app/api/v1/dashboards/{key}

A dashboard the user asks your agent to build: it shows as its own tab on the Dashboard in mySDR (the tabs are only dashboards; mySDR builds the first one, Overview with the key mysdr_overview, from the first data) and refreshes by itself. You describe it; mySDR draws it from the live Leads and Companies tables and the activity log, with the same filters as GET /tables/leads, so a block counts the same rows as the table. No HTML or code: a dashboard is a list of blocks of five types. Changing or removing it is something the user asks your agent, not a button in mySDR. These routes are the tools save_dashboard, list_dashboards, get_dashboard and delete_dashboard of the assistant server.

Authentication#

Send Authorization: Bearer gtk_…. Create the key under API keys in the menu. Every gtk_ key can call these routes, also while the Signals API is closed. A missing, invalid or revoked key is 401.

Path parameters#

  • key string · required — The key of the dashboard (pipeline_q4).

Response#

  • key string · required — The key you sent.
  • removed boolean · required — Always true.
  • dashboard_url string · required — Companies in mySDR.

Credits#

Free. This call never uses credits.

Errors#

  • 400 invalid_request — A key that is not valid.
  • 404 not_found — The workspace has no dashboard with this key.
  • 401 authentication_error — The Authorization header is missing, or the key is unknown or revoked.
  • 403 permission_error — API access is not part of your plan, or your account is suspended.
  • 429 rate_limit_error — More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header.
  • 503 service_unavailable — The API is temporarily unavailable. Retry later.
  • 500 internal_error — Something went wrong on our side.

Example

DELETE/dashboards/{key}
curl -X DELETE "https://mysdr.app/api/v1/dashboards/pipeline_q4" \
  -H "Authorization: Bearer $MYSDR_API_KEY"
Response
{
  "key": "pipeline_q4",
  "removed": true,
  "dashboard_url": "https://mysdr.app/en/gtm/companies"
}