Skip to main content
POST
Add a custom property to accounts, people or deals.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

entityType
string | null
required

The entity type to add the property to: Account, Person or Deal

Body

application/json

The custom property to add

A custom property to add to accounts, people or deals. Only Label is required.

Label
string
required

The name of the property shown in Outseta, for example "T-shirt size". Unique among the entity type's custom properties, and not the label of a standard property.

Minimum string length: 1
SystemName
string | null

The name of the property in the API, webhooks and forms, for example TShirtSize. Starts with a letter and holds only letters, numbers and _. Unique for the entity type, and not the name of a standard property. Derived from Label when left out.

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

The control used to fill in the property: Text (the default), TextArea, Number, Date, Checkbox (True or False), Select (a dropdown with one choice), RadioList (one choice) or CheckboxList (several choices).

ControlParams
string | null

The control's settings: a JSON object serialized into a string, not a nested object. Select, RadioList and CheckboxList need their options, for example "{"Options":["Small","Medium","Large"]}". Number may set a Step, for example "{"Step":0.01}"; Text may set HintText and Pattern (a regular expression).

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