Deals

Create a deal

Create a revenue opportunity linked to a contact or company.

Overview

Use this API to create a revenue opportunity linked to a contact or company. It requires bearer api key authentication and the deals:write scope.

POST/deals

cURL

POST

bash

curl --request POST \  --url 'https://api.atlascrm.dev/v1/deals' \  --header 'Authorization: Bearer crm_live_xxx' \  --header 'Content-Type: application/json' \  --data '{  "name": "Enterprise rollout",  "amount": "25000",  "currency": "USD",  "companyId": "cmp_123"}'

Authorization

Bearer API key

deals:write

Sample Request Body

json

{  "name": "Enterprise rollout",  "amount": "25000",  "currency": "USD",  "companyId": "cmp_123"}

Sample Response

json

{  "status": "success",  "data": {    "id": "deal_789",    "name": "Enterprise rollout",    "amount": 25000,    "currency": "USD",    "stage": "qualified"  }}

Status Codes

Code	Description
201	Deal was created.

Headers

AuthorizationstringRequired

Bearer token for your workspace.

Example: Bearer crm_live_xxx

Object	Description
Authorization string	RequiredBearer token for your workspace. Example: Bearer crm_live_xxx

Request body

namestringRequired

Deal name.

Example: Enterprise rollout

amountnumberRequired

Deal value in the selected currency.

Example: 25000

currencystringRequired

ISO 4217 currency code.

Example: USD

companyIdstringOptional

Associated company identifier.

Example: cmp_123

Object	Description
name string	RequiredDeal name. Example: Enterprise rollout
amount number	RequiredDeal value in the selected currency. Example: 25000
currency string	RequiredISO 4217 currency code. Example: USD
companyId string	OptionalAssociated company identifier. Example: cmp_123

Response fields

data.idstring

Deal identifier.

data.stagestring

Initial pipeline stage.

Object	Description
data.id string	Deal identifier.
data.stage string	Initial pipeline stage.