Deal

Create a new deal

POST

http://localhost:3000/api/deals

Create a new deal

curl -X POST 'http://localhost:3000/api/deals' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "select": {},
  "relations": {},
  "where": {},
  "order": {},
  "withDeleted": true,
  "take": 0,
  "skip": 0
}'

const body = `{
  "select": {},
  "relations": {},
  "where": {},
  "order": {},
  "withDeleted": true,
  "take": 0,
  "skip": 0
}`;

const response = await fetch('http://localhost:3000/api/deals', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "select": {},
  "relations": {},
  "where": {},
  "order": {},
  "withDeleted": true,
  "take": 0,
  "skip": 0
}'''

response = requests.post(
    'http://localhost:3000/api/deals',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "select": {},
  "relations": {},
  "where": {},
  "order": {},
  "withDeleted": true,
  "take": 0,
  "skip": 0
}

201

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "probability": 0,
  "stageId": "string",
  "clientId": "string"
}

Body

application/json

selectobject

relationsobject

whereobjectrequired

orderobject

withDeletedboolean

takenumber[0, 100]

skipnumber>= 0

Response

201CreatedDeal

The deal has been successfully created.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

probabilitynumberrequired

stageIdstringrequired

clientIdstring

400Bad Request

Invalid request data.

401Unauthorized

Unauthorized

403Forbidden

Forbidden

500Internal Server Error

Internal server error.

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo