-
Leads: https://app.futuresimple.com/apis/leads/api/v1/custom_fields.json
-
Contacts: https://app.futuresimple.com/apis/crm/api/v1/custom_fields.json
-
Deals: https://app.futuresimple.com/apis/sales/api/v1/deal_custom_fields.json
-
Leads: https://app.futuresimple.com/apis/leads/api/v1/custom_fields/[id].json
-
Contacts: https://app.futuresimple.com/apis/crm/api/v1/custom_fields/[id].json
-
Deals: https://app.futuresimple.com/apis/sales/api/v1/deal_custom_fields/[id].json
some custom fields can be used as additional filtering options in the web app, to enable this
pass "filterable":"true"
as a parameter to the "custom_field"
- Visible on both Person and Company pages:
"custom_scope":{"people":"1","company":"2"}
- Person pages only:
"custom_scope":{"people":"1"}
- Company pages only:
"custom_scope":{"company":"2"}
{"custom_field":{"name":"word","field_type":"string","settings":null}}
Filterable
{"custom_field":{"name":"paragraph","field_type":"text","settings":null}}
Not filterable
{"custom_field":{"name":"number","field_type":"number","settings":null,}}
Filterable
Non-numeric values are cut out.
{"custom_field":{"name":"bool","field_type":"bool","settings":null}}
Not filterable
{"custom_field":{"name":"Choice","field_type":"list","settings":"0;first choice,1;second choice"}}
Filterable
{"custom_field":{"name":"date only","field_type":"date","settings":"%Y/%m/%d"}}
{"custom_field":{"name":"date and time","field_type":"date","settings":"%Y/%m/%d %H:%M"}}
Filterable
{"custom_field":{"name":"email address","field_type":"email","settings":null}}
Not filterable
{"custom_field":{"name":"phone number","field_type":"phone","settings":null}}
Not filterable
{"custom_field":{"name":"address","field_type":"address","settings":null}}
Not filterable
{"custom_field":{"name":"website","field_type":"url","settings":null}}
Not filterable
Since custom field names are unique within their scope (Leads, Contacts, Deals) you can pass them as parameters when creating or updating an object. The representation has the name of the custom field as the key and values as the value:
"custom_field_values":{"Revenue type":"text entered here"}
"custom_fields":{"Revenue type":"text entered here"}
"name": value
"name": "value
"name": value
"name": value
(0 or 1)
"name": choice id
"name": value
(eg. "1/31/2014" or "1/31/2014 3:02")
"name": value
"name": {"street": value, "city": value, "region": value, "zip": value, "country": value}
"name": value
"name": value
@rkshakya
I hope that helps, it took me a while to get it working.
Note that the name of the custom field must match how it is the admin. Also, for the drop down example above to get the ID I had to go to the drop down option in the admin, inspect the element and get the ID from the data attribute. I don't know if there is an easier way.