Create deal

Create an origination deal in the specified organisation and workspace.

Authorization

ApiKeyAuth

x-api-key<token>

API key for authentication

In: header

Path Parameters

orgId*string

workspaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

description*string

priority*string

Value in

"low"
"medium"
"high"
"urgent"

contactId*string

assignedTo*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

expectedClosureDate*string

followUpDate*string

grossAnnualSalary?string

payrollCycle?string

employerId?string

employerName?string

Response Body

`application/json`

curl -X POST "https://example.com/organisation/string/workspace/string/origination/deal" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string",    "priority": "low",    "contactId": "string",    "assignedTo": "7869c1a9-a680-4086-b6f5-9e78a651f6f2",    "expectedClosureDate": "string",    "followUpDate": "string"  }'

{  "dealId": "string"}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`