Skip to main content
PUT
/
records
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "objectType": "<string>",
    "source": "<string>",
    "externalId": "<string>",
    "fields": {},
    "fieldUpdatedAt": {},
    "tombstonedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "phoneE164": "<string>",
    "email": "<string>"
  },
  "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.

Body

application/json
objectType
string
required

The object type (e.g. "contacts"); learned on first write.

externalId
string
required

The record's id in your source app (REQUIRED; the upsert identity).

source
string

The syncing app (default "api"; the Zapier app passes "zapier"). Part of the identity.

fields
object

The (possibly partial) field map to shallow-merge in.

Response

The upserted record.

success
boolean
required
data
object
required

One pre-synced customer record the context_lookup skill greets a caller from.

message
string
errors
object[]