Skip to main content
PUT
Create or update a custom object record by external_id

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

object
string
required

The custom object's key, as GET /v1/objects lists it

Required string length: 1 - 200

Query Parameters

match
string
required

The key that finds the record to update, with the account or contact it belongs to

Allowed value: "external_id"

Body

application/json
account_id
string

The account it belongs to, for an object whose records belong to accounts

contact_id
string

The contact it belongs to, for an object whose records belong to contacts

external_id
string

Its id in your system, unique on its account or contact: what an upsert matches on

fields
Fields · object | null

Field keys to values, keyed as GET /v1/fields?object= lists them

Response

Successful Response

id
string
required
object
string
required

The custom object's key

result
enum<string>
required
Available options:
created,
updated
account_id
string | null

The account it belongs to; null when it belongs to a contact

contact_id
string | null

The contact it belongs to; null when it belongs to an account

created_at
string<date-time> | null
external_id
string | null

Its id in the system that fills the object, such as a Salesforce record id

fields
Fields · object

Its values, keyed as GET /v1/fields?object= lists them

updated_at
string<date-time> | null