CLclose
contacts

Create a new contact

Changed on

Contacts belong to exactly one Lead (specified by lead_id). If you do not provide a lead_id then a new lead will be created, named after the contact.

Custom field values can be set by including custom.cf_* keys in the request body, e.g. "custom.cf_abc123": "value".

post/contact/

Request

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

Query parameters

_fieldsstring

Comma-separated list of fields to include in the response.

Request body

created_bystring nullable
date_createdstring date-time nullable
lead_idstring nullable
namestring nullable
timezonestring nullable

IANA timezone identifier

titlestring nullable

Response

Successful response

created_bystring nullable required
created_by_agent_idstring nullable
date_createdstring date-time required
date_updatedstring date-time required
display_namestring required
idstring required
lead_idstring nullable
namestring nullable required
organization_idstring required
timezonestring nullable
timezone_sourcestring nullable
titlestring nullable required
updated_bystring nullable required
updated_by_agent_idstring nullable

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

  • 7bdb9cfcca22Revision changes
    • breaking

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

    • info

      removed the pattern property ^custom\. from the request body