Skip to main content
PATCH
/
record-types
/
{type}
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "displayName": "<string>",
    "fields": [
      {
        "name": "<string>",
        "label": "<string>",
        "piiClass": "<string>",
        "source": "<string>"
      }
    ],
    "source": "<string>",
    "recordCount": 123,
    "lastRecordReceivedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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.

Path Parameters

type
string
required

Body

application/json
displayName
string
fields
object[]

Response

The updated object type.

success
boolean
required
data
object
required

One row of the per-org object-type registry (the single source of truth for a synced type's fields).

message
string
errors
object[]