Objects

Create a deal

Create a deal in the tenant and project derived from the access token.

Overview

Use this endpoint to create a deal with one or more properties. Pipeline-aware objects use the public aliases pipeline and stage. It requires public api oauth access token authentication and the crm.deals.write scope.

POST/api/objects/deals

cURL

POST

bash

curl --request POST \  --url 'https://crm.notifyy.io/api/objects/deals' \  --header 'Authorization: Bearer nfy_public_api_access_token' \  --header 'Content-Type: application/json' \  --data '{  "properties": [    {      "internal_name": "name",      "value": "Enterprise Renewal"    },    {      "internal_name": "amount",      "value": "12000"    },    {      "internal_name": "currency",      "value": "USD"    },    {      "internal_name": "pipeline",      "value": "sales_pipeline"    },    {      "internal_name": "stage",      "value": "proposal_sent"    }  ],  "associations": [    {      "to": {        "object": "company",        "id": "456"      }    },    {      "to": {        "object": "contact",        "id": "789"      }    }  ]}'

Authorization

Public API OAuth access token

crm.deals.write

Sample Request Body

json

{  "properties": [    {      "internal_name": "name",      "value": "Enterprise Renewal"    },    {      "internal_name": "amount",      "value": "12000"    },    {      "internal_name": "currency",      "value": "USD"    },    {      "internal_name": "pipeline",      "value": "sales_pipeline"    },    {      "internal_name": "stage",      "value": "proposal_sent"    }  ],  "associations": [    {      "to": {        "object": "company",        "id": "456"      }    },    {      "to": {        "object": "contact",        "id": "789"      }    }  ]}

Sample Response

json

{  "success": true,  "message": "Deal created successfully",  "data": {    "id": 999,    "name": "Enterprise Renewal",    "currency": "USD",    "amount": "12000",    "closeDate": null,    "createdDate": null,    "priority": null,    "dealType": null,    "createdAt": "2026-07-31T10:15:30Z",    "updatedAt": "2026-07-31T10:15:30Z"  }}

Status Codes

Code	Description
201	Deal was created.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

Content-TypestringRequired

Request body media type.

Example: application/json

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token
Content-Type string	RequiredRequest body media type. Example: application/json

Request body

propertiesobject[]Required

Deal properties to create. At least one property is required.

properties[].internal_namestringRequired

Internal property name. Use pipeline and stage instead of internal ID fields.

Example: name

properties[].valueanyOptional

Scalar property value.

Example: Enterprise Renewal

associationsobject[]Optional

Associations to create along with the deal.

Object	Description
properties object[]	RequiredDeal properties to create. At least one property is required.
properties[].internal_name string	RequiredInternal property name. Use pipeline and stage instead of internal ID fields. Example: name
properties[].value any	OptionalScalar property value. Example: Enterprise Renewal
associations object[]	OptionalAssociations to create along with the deal.

Response fields

data.idinteger

Deal record ID.

data.namestring | null

Deal name.

Example: Enterprise Renewal

data.amountstring | null

Deal amount.

Example: 12000

Object	Description
data.id integer	Deal record ID.
data.name string \| null	Deal name. Example: Enterprise Renewal
data.amount string \| null	Deal amount. Example: 12000