Error
A valid request URL is required to generate request examples{
"success": true,
"data": null
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Records
Delete a caller-context record
Soft-deletes (tombstones) a record so the deletion propagates — the agent stops greeting a removed contact. Lookups exclude it; a later upsert restores it.
DELETE
/
records
/
{objectType}
/
{externalId}
Error
A valid request URL is required to generate request examples{
"success": true,
"data": null
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
records:write
Upsert / delete / bulk-import / purge caller-context records and edit type metadata.
Path Parameters
The record's object type (e.g. "contacts").
The record's id in your source app (the upsert identity).
Query Parameters
Pin the record's source (else the most-recent match across sources).