Skip to main content
POST
/
v1
/
resources
/
crmOpportunity
Create Opportunity
const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-api-secret': '<api-key>',
    'x-connector-id': '<api-key>',
    'x-owner-id': '<api-key>',
    'x-session-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    amount: 1,
    currency: '<string>',
    stage: {
      id: '<string>',
      object: 'resourceRef',
      model: '<string>',
      fields: '<unknown>',
      rawResource: '<unknown>',
      remote: {id: '<string>'},
      createdAt: '<string>',
      updatedAt: '<string>'
    },
    pipeline: {
      id: '<string>',
      object: 'resourceRef',
      model: '<string>',
      fields: '<unknown>',
      rawResource: '<unknown>',
      remote: {id: '<string>'},
      createdAt: '<string>',
      updatedAt: '<string>'
    },
    owner: {
      id: '<string>',
      object: 'resourceRef',
      model: '<string>',
      fields: '<unknown>',
      rawResource: '<unknown>',
      remote: {id: '<string>'},
      createdAt: '<string>',
      updatedAt: '<string>'
    },
    contacts: [
      {
        id: '<string>',
        object: 'resourceRef',
        model: '<string>',
        fields: '<unknown>',
        rawResource: '<unknown>',
        remote: {id: '<string>'},
        createdAt: '<string>',
        updatedAt: '<string>'
      }
    ],
    companies: [
      {
        id: '<string>',
        object: 'resourceRef',
        model: '<string>',
        fields: '<unknown>',
        rawResource: '<unknown>',
        remote: {id: '<string>'},
        createdAt: '<string>',
        updatedAt: '<string>'
      }
    ],
    engagements: [
      {
        id: '<string>',
        object: 'resourceRef',
        model: '<string>',
        fields: '<unknown>',
        rawResource: '<unknown>',
        remote: {id: '<string>'},
        createdAt: '<string>',
        updatedAt: '<string>'
      }
    ]
  })
};

fetch('https://api.runmorph.dev/v1/resources/crmOpportunity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "object": "resource",
  "model": "<string>",
  "id": "<string>",
  "remote": {
    "id": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required
​
x-api-secret
string
header
required
​
x-connector-id
string
header
required
​
x-owner-id
string
header
required
​
x-session-token
string
header
required

Query Parameters

​
returnResource
default:false

Body

​
name
string

Opportunity name

Required string length: 1 - 250
​
amount
number

Opportunity amount

Required range: x >= 0
​
currency
string

Currency code

Required string length: 3
​
stage
object

Stage of the opportunity

​
pipeline
object

Pipeline of the opportunity

​
owner
object

User that own the opportunity

​
contacts
object[]

Associated contacts

​
companies
object[]

Associated companies

​
engagements
object[]

Associated engagements

Response

Created

​
object
enum<string>
default:resource
required
Available options:
resourceRef
​
model
string
required
​
id
string
required
​
remote
object