Sign in
opportunities

Create One opportunity

post/opportunities

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/opportunities
  • Auth: HTTP bearer

Query parameters

depth0 | 1

Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations

upsertboolean

If true, creates the object or updates it if it already exists.

Request body

namestring

The opportunity name

closeDatestring date-time

Opportunity close date

stage'NEW' | 'SCREENING' | 'MEETING' | 'PROPOSAL' | 'CUSTOMER'

Opportunity stage

positionnumber

Opportunity record position

pointOfContactIdstring uuid
companyIdstring uuid
ownerIdstring uuid

Example request

{
  "name": "Opportunity name",
  "amount": {
    "amountMicros": "211000000",
    "currencyCode": "EUR"
  },
  "stage": "NEW"
}

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.