Miscellaneous
Values used by several endpoints that aren't described on the endpoint pages themselves.
Contacts
Gender
A contact's gender is a string. It is not detected automatically. See the user model.
| Value | Meaning |
|---|---|
unknown | Not known (the default). |
male | Male. |
female | Female. |
Phone number format
Phone numbers must be in the E.164 format, for example +48123456789. To store a phone number in another format, create a custom attribute for it.
Attribute types
When you create an attribute, its value_type is one of:
| Value | Attribute type |
|---|---|
boolean | True or false. |
integer | Whole number. |
float | Floating-point number. |
string | Text. |
date | Date. |
datetime | Date and time. |
fixed | One or more fixed choices. |
json | JSON. |
Message source types
Where a message was sent from. When you create a conversation or a message, send source as a number; without it, the message gets 3 (API). Messages in responses return it as a label.
| Value | Label in responses |
|---|---|
1 | Chat |
2 | Email |
3 | API (the default) |
4 | SMS |
8 | Facebook |
9 | Instagram |
10 | ChatAI |
Any other number returns 400 with "is not a valid choice".
Deals
Deal statuses
| Value | Status |
|---|---|
0 | Abandoned |
1 | In progress |
2 | Won |
3 | Lost |
4 | Archived |
Deal scopes
The possible values of a deal's scope. The scope currently has no effect. See the deal model.
| Value | Scope |
|---|---|
1 | Open |
2 | Participants (the default) |
Activity statuses
| Value | Status |
|---|---|
0 | Not planned |
1 | Planned |
2 | Recently finished |
3 | Overdue |
Product event types
When you create a product event, its event_type is one of:
add to cart, purchase, liking, add to observation, order, reservation, return, view, click, detail, add, remove, checkout, checkout option, refund, promo click