Skip to main content
PUT
Update a custom property of accounts, people or deals.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

entityType
string | null
required

The entity type the definition belongs to: Account, Person or Deal

definitionUid
string | null
required

The definition's unique identifier

Body

application/json

The fields to change

The fields of a custom property that an update may change. Every field is optional: a field left out keeps its current value.

Label
string

The name of the property shown in Outseta. Unique among the entity type's custom properties, and not the label of a standard property. Cannot be null.

SystemName
string

The name of the property in the API, webhooks and forms. Starts with a letter and holds only letters, numbers and _. Changing it keeps the stored values under the new name; anything that uses the old name has to be updated. Cannot be null.

Pattern: ^[A-Za-z][A-Za-z0-9_]*$
ControlType
string

The control used to fill in the property: Text, TextArea, Number, Date, Checkbox, Select, RadioList or CheckboxList. Cannot be null.

ControlParams
string | null

The control's settings: a JSON object serialized into a string, replaced as a whole. To add an option, send the full list, for example "{"Options":["Small","Medium","Large","X-Large"]}".

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
ControlType
string | null
Maximum string length: 250
ControlParams
string | null
Label
string | null
SystemName
string | null
EntityType
enum<integer>

0 - None, 1 - Account, 2 - Person, 3 - Deal, 4 - Case, 5 - Invoice, 6 - EmailLog, 7 - Plan, 8 - DiscountCoupon, 9 - AddOn, 10 - Task, 11 - Segment, 12 - Broadcast, 13 - Article

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
Position
integer<int32> | null
Hidden
boolean