Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "ot_1a2b",
"name": "contacts",
"displayName": "Contacts",
"source": "api",
"recordCount": 1284,
"lastRecordReceivedAt": "2026-07-12T10:00:00.000Z",
"fields": [
{
"name": "email",
"label": "Email address",
"kind": "string",
"piiClass": "contact",
"source": "api"
},
{
"name": "plan",
"label": "Plan tier",
"kind": "string",
"piiClass": "",
"source": "api"
}
],
"createdAt": "2026-05-01T09:00:00.000Z",
"updatedAt": "2026-07-12T11:00:00.000Z"
}
}{
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Records
Update a record type
Applies label and PII-class overrides to a type’s existing fields (by name), and optionally its display name. The field set and kinds are learned from writes and can’t be changed here.
PATCH
/
record-types
/
{type}
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "ot_1a2b",
"name": "contacts",
"displayName": "Contacts",
"source": "api",
"recordCount": 1284,
"lastRecordReceivedAt": "2026-07-12T10:00:00.000Z",
"fields": [
{
"name": "email",
"label": "Email address",
"kind": "string",
"piiClass": "contact",
"source": "api"
},
{
"name": "plan",
"label": "Plan tier",
"kind": "string",
"piiClass": "",
"source": "api"
}
],
"createdAt": "2026-05-01T09:00:00.000Z",
"updatedAt": "2026-07-12T11:00:00.000Z"
}
}{
"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>"
}
]
}{
"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 object type's snake_case name (from listRecordTypes).