Create deal

Authorization

bearerAuth

AuthorizationBearer <token>

Paste the full personal access token or organization API key value. Examples: acq_live_..., acq_org_.... Tokens can be limited to resource/action scopes such as workspaces:read, people:write, and deals:write. Some integration endpoints require an organization key even when a personal token has the named resource scope.

In: header

Path Parameters

workspaceId*string

Workspace id.

Formatuuid

Header Parameters

idempotency-key?string

Optional for organization API keys on endpoints that explicitly support synchronous idempotency. Reuse the same key only with the same workspace, action, target, and request body. A successful replay returns the original HTTP status, response body, and Location header. Personal access tokens cannot use this header.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Deal display name.

Length1 <= length <= 160

amount?|

Deal amount as a JSON number. Null means no amount is set. Values are stored as database decimals and returned as JSON numbers in v1.

Range0 <= value <= 1000000000000

currency?|

ISO 4217 currency code. Defaults to USD.

Match^[A-Z]{3}$

Length3 <= length <= 3

Default"USD"

probability?|

Deal probability percentage from 0 to 100.

Range0 <= value <= 100

pipelineId*string

Pipeline id. Must belong to the workspace.

Formatuuid

stageId*string

Pipeline stage id. Must belong to pipelineId and the workspace.

Formatuuid

primaryPersonId?|

Primary person id. Must belong to the workspace.

Formatuuid

companyId?string

Company id to link to the new deal. Must belong to the workspace.

Formatuuid

ownerId?|

Workspace member user id that should own this deal. Defaults to the personal access-token owner and defaults to null for organization API keys.

Formatuuid

source?|

Lengthlength <= 500

tags?array<>|

Deal tags. Null means no tags are set.

Itemsitems <= 50

lostReason?|

Lengthlength <= 500

wonReason?|

Lengthlength <= 500

closedAt?|

Close timestamp. Terminal won/lost stages set this automatically when omitted.

Formatdate-time

customFields?array<>

Values for existing CRM custom field definitions. Omit customFields to leave every value unchanged, pass an empty array for no changes, or pass null as an item value to clear that field.

Itemsitems <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/deals" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "stageId": "4ac83d66-64fa-48da-9505-57df43404af7"  }'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",    "name": "string",    "amount": 0,    "currency": "str",    "valuePeriod": "one_time",    "annualisedAmount": 0,    "description": "string",    "probability": 0,    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "stageId": "4ac83d66-64fa-48da-9505-57df43404af7",    "primaryPersonId": "52733c47-e234-4110-9fc1-ea836a414c3f",    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",    "source": "string",    "tags": [      "string"    ],    "lostReason": "string",    "wonReason": "string",    "closedAt": "2019-08-24T14:15:22Z",    "customFields": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "label": "string",        "type": "text",        "value": "string"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "links": {      "self": "http://example.com"    }  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

Create deal

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

408application/json

409application/json

413application/json

415application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`