0dcf3303e9d7
Create a new lead
Contacts, addresses, and custom fields can all be nested in the lead. Activities, tasks, and opportunities must be posted separately.
status / status_id (optional): Post either status or status_id (but not both). If neither is provided, the organization's default (first) status will be used. Using status_id is recommended so that users can rename statuses in the UI without breaking your implementation.
custom.FIELD_ID (optional): Set custom fields by setting custom.FIELD_ID to the field value, where FIELD_ID is the ID of the custom field, e.g.:
{ "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c": "value", "custom.cf_8wtBWsdRU2Fur7GDnEeXQ7ra2Vu7R4hG1SNYdiEhh0F": "other value" }
If a custom field has accepts_multiple_values: true, the entire value will be replaced. For example, given a Lead has a Custom Choice Field with value ["A", "B"], adding choice "C" would mean setting the value to ["A", "B", "C"].
Note that using the custom field dict or the custom.FIELD_NAME syntax (instead of custom field IDs) is deprecated and will be removed from the API. See Custom Fields for more details.
Response
Successful response