CLclose
leads

Create a new lead

Changed on

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.

post/lead/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/lead/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Response

Successful response

contact_idsstring[] required
contacts_summarystring
created_bystring nullable required
created_by_agent_idstring nullable

ID of the agent that created the lead, or null if no agent created it.

created_by_namestring nullable
date_createdstring date-time required
date_updatedstring date-time required
descriptionstring nullable required
display_namestring
html_urlstring required
idstring required
localtimestring date-time nullable
namestring nullable required
organization_idstring required
primary_address_fullstring nullable
primary_address_summarystring nullable
recent_callsobject[]
sourcestring nullable
status_idstring required
status_labelstring
summariesobject[]
tasksobject[]
updated_bystring nullable required
updated_by_agent_idstring nullable

ID of the agent that last updated the lead, or null if the last update wasn't made by an agent.

updated_by_namestring nullable
urlstring nullable required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the / response property for the status

    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the / response property for the status

  • 784846be4a00Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status