Create an opportunity | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/opportunity/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "confidence": 90,
  "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
  "note": "i hope this deal closes...",
  "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "value": 500,
  "value_period": "monthly",
  "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "https://www.example.com/contract.pdf"
}'

{
  "annualized_expected_value": 540000,
  "annualized_value": 600000,
  "confidence": 90,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-20T10:11:50.520000+00:00",
  "date_updated": "2013-02-20T10:11:50.520000+00:00",
  "expected_value": 45000,
  "id": "oppo_bJoqD4QX21AfA2fAGX5HmPQ1EgGoWBannvLj4khIfPH",
  "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
  "note": "i hope this deal closes...",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "value": 50000,
  "value_period": "monthly",
  "lead_name": "Wayne Enterprises (Sample Lead)",
  "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
  "pipeline_name": "Sales",
  "status_label": "Active",
  "status_type": "active",
  "user_name": "Anthony Nemitz",
  "value_currency": "USD",
  "value_formatted": "$50 monthly",
  "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "https://www.example.com/contract.pdf"
}

status_id (optional): Post a status_id to create an opportunity with a specific status. If omitted, the organization’s default (first) status will be used. See the Opportunity Status API.

lead_id (optional): Opportunities belong to exactly one Lead. If you do not provide a lead_id then a new lead will be created (appearing as “Untitled” in the UI).

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.:

1 { "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 an Opportunity 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.

**status_id** (optional): Post a `status_id` to create an opportunity with a specific status. If omitted, the organization's default (first) status will be used. See the [Opportunity Status API](/resources/opportunity-statuses/). **lead_id** (optional): Opportunities belong to exactly one Lead. If you do not provide a `lead_id` then a new lead will be created (appearing as "Untitled" in the UI). **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.: ```json { "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 an Opportunity 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](/resources/custom-fields/) for more details.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

attachmentslist of objects or nullOptional

confidenceinteger or nullOptional

contact_idstring or nullOptional

created_bystring or nullOptional

custom_fieldsmap from strings to any or nullOptional

date_createddatetime or nullOptional

date_wondatetime or nullOptional

lead_idstring or nullOptional

notestring or nullOptional

status_idstring or nullOptional

user_idstring or nullOptional

valueinteger or nullOptional

value_periodenum or nullOptional

Allowed values:

Response

Successful response

annualized_expected_valueinteger or null

annualized_valueinteger or null

confidenceinteger

contact_idstring or null

created_bystring or null

date_createddatetime

date_lostdatetime or null

date_updateddatetime

date_wondate or null

expected_valueinteger or null

idstring

lead_idstring

notestring or null

organization_idstring

status_idstring

updated_bystring or null

user_idstring

valueinteger or null

value_periodenum

Allowed values:

attachmentslist of objects

comment_summaryobject or null

contact_namestring or null

created_by_namestring or null

integration_linkslist of objects

is_stalledboolean

lead_namestring or null

lead_primary_emailobject or null

lead_primary_phonelist of objects or null

pipeline_idstring or null

pipeline_namestring or null

stall_statusobject or null

status_display_namestring

status_labelstring

status_typeenum

Allowed values:

suggested_actionobject or null

updated_by_namestring or null

user_namestring or null

value_currencystring or null

value_formattedstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

status_id (optional): Post a status_id to create an opportunity with a specific status. If omitted, the organization’s default (first) status will be used. See the Opportunity Status API.

lead_id (optional): Opportunities belong to exactly one Lead. If you do not provide a lead_id then a new lead will be created (appearing as “Untitled” in the UI).

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.:

1 { "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c": "value", "custom.cf_8wtBWsdRU2Fur7GDnEeXQ7ra2Vu7R4hG1SNYdiEhh0F": "other value" }

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.