CRM

Create a deal

Requires the crm.write scope.

post/crm/deals

Request

  • Base URL: https://developer.solofire.com/v1
  • URL: https://developer.solofire.com/v1/crm/deals
  • Auth: HTTP bearer

Query parameters

pipeline_idstring

Only deals in this pipeline.

stage_idstring

Only deals at this stage.

statusstring

open, won or lost.

account_idstring

Only deals on this account.

contact_idstring

Only deals with this contact attached.

owner_user_idstring

Only deals owned by this member.

qstring

Case-insensitive match on the deal name.

limitinteger

Page size, 1 to 200. Defaults to 50.

cursorstring

The next_cursor from a previous response.

updated_sincestring

Only records changed after this RFC 3339 timestamp.

Request body

namestring required

Deal name.

amountnumber

Deal value.

currencystring

ISO 4217 code. Defaults to USD.

statusstring

open, won or lost. Derived from the stage when stage_id is given.

close_datestring

Expected or actual close date, YYYY-MM-DD.

close_reasonstring

Why it was won or lost.

next_stepstring

The next action.

notesstring

Free-form notes.

pipeline_idstring

Pipeline. Defaults to the company default pipeline.

stage_idstring

Stage within the pipeline. Moving stage journals history; a won/lost stage sets status.

account_idstring

Linked account.

owner_user_idstring

Owning member.

custom_fieldsobject

Arbitrary key/value metadata.

Response

Created

object required

Changes

No recorded changes to this operation across all 1 revision of this API.