Skip to main content
PUT
Update Object Type

Authorizations

X-API-Key
string
header
required

Path Parameters

type_key
string
required

Body

application/json
singular_label
string | null

Name of one record, e.g. Subscription

plural_label
string | null

Name of the list, e.g. Subscriptions

description
string | null
title_attribute
string | null

Key of the text attribute shown as the record's name

status
string | null

experimental, active or deprecated

alert_rules
Alert Rules · object[] | null

A task opens for each record that starts matching: [{"title": "Renewal in 30 days", "filter": {"renews_on": {"$lte": {"$days_from_now": 30}}}, "assign_attribute": "owner"}]

rules
Rules · object[] | null

Values a record must have once it matches a filter: [{"when": {"stage": "Lost"}, "require": ["lost_reason"], "message": "Say why the deal was lost."}]

Response

200

OK