Create Deal

Create a deal, by default in the first open stage of the default pipeline.

POST /api/v1/crm/deals

Create Deal

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/crm/deals \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "currency": "<string>",
  "expected_close_date": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_ids": [
    "<string>"
  ],
  "custom_fields": {},
  "lost_reason": "<string>",
  "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

201

{}

Authorizations

X-API-Key · string · header · required

Body

application/json

title · string · required

stage_id · string<uuid> | null

amount · string number

currency · string | null

ISO 4217 code, e.g. EUR

expected_close_date · string | null

YYYY-MM-DD

owner_id · string<uuid> | null

organization_id · string<uuid> | null

contact_ids · string[] | null

Replaces the deal's contacts

custom_fields · Custom Fields · object | null

lost_reason · string | null

pipeline_id · string<uuid> | null

Defaults to the default pipeline

Response

201 - application/json

Created

The response is of type Response · object.