Skip to content

Opportunities.md

Latest commit

 

History

History
3548 lines (2465 loc) · 52.4 KB

Opportunities.md

File metadata and controls

3548 lines (2465 loc) · 52.4 KB

Opportunities API

Source: HighLevel API 2.0 Documentation Crawled: 2026-03-25

Table of Contents

Opportunities

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/opportunities

Skip to main content

Documentation for Opportunities API

📄️ Get Opportunity \ Get Opportunity📄️ Delete Opportunity \ Delete Opportunity📄️ Update Opportunity \ Update Opportunity📄️ Update Opportunity Status \ Update Opportunity Status📄️ Upsert Opportunity \ Upsert Opportunity📄️ Create Opportunity \ Create Opportunity

Create Opportunity

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/create-opportunity/index.html

Skip to main content

Create Opportunity

POST https://services.leadconnectorhq.com/opportunities/

Create Opportunity

Requirements

Scope(s)

opportunities.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

  • application/json

Body required

pipelineId stringrequired

pipeline Id

Example:VDm7RPYC2GLUvdpKmBfC

locationId stringrequired

Example:ve9EPM428h8vShlRW1KT

name stringrequired

Example:First Opps

pipelineStageId string

Example:7915dedc-8f18-44d5-8bc3-77c04e994a10

status stringrequired

Possible values: [open, won, lost, abandoned, all]

contactId stringrequired

Example:mTkSCb1UBjb5tk4OvB69

monetaryValue number

Example:220

assignedTo string

Example:082goXVW3lIExEQPOnd3

customFields object[]

Add custom fields to opportunities.

Array [

anyOf
\

  • customFieldsInputStringSchema\
  • customFieldsInputArraySchema\
  • customFieldsInputObjectSchema

    id string

    Pass either id or key of custom field

    Example:6dvNaf7VhkQ9snc5vnjJ

    key string

    Pass either id or key of custom field

    Example:my_custom_field

    field_value string

    Example:9039160788

    id stringrequired

    Example:6dvNaf7VhkQ9snc5vnjJ

    key string

    Example:my_custom_field

    field_value string[]

    Example:["test","test2"]

    id stringrequired

    Example:6dvNaf7VhkQ9snc5vnjJ

    key string

    Example:my_custom_field

    field_value object

    Example:{}

    ]

Responses ​

  • 201
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

opportunity object

id string

Example:yWQobCRIhRguQtD2llvk

name string

Example:testing

monetaryValue number

Example:500

pipelineId string

Example:VDm7RPYC2GLUvdpKmBfC

pipelineStageId string

Example:e93ba61a-53b3-45e7-985a-c7732dbcdb69

assignedTo string

Example:zT46WSCPbudrq4zhWMk6

status string

Example:open

source string

Example:``

lastStatusChangeAt string

Example:2021-08-03T04:55:17.355Z

lastStageChangeAt string

Example:2021-08-03T04:55:17.355Z

lastActionDate string

Example:2021-08-03T04:55:17.355Z

indexVersion string

Example:1

createdAt string

Example:2021-08-03T04:55:17.355Z

updatedAt string

Example:2021-08-03T04:55:17.355Z

contactId string

Example:zT46WSCPbudrq4zhWMk6

locationId string

Example:zT46WSCPbudrq4zhW

contact object

id string

Example:byMEV0NQinDhq8ZfiOi2

name string

Example:John Deo

companyName string

Example:Tesla Inc

email string

Example:john@deo.com

phone string

Example:+1202-555-0107

tags string[]

notes array[]

tasks array[]

calendarEvents array[]

lostReasonId string

Example:zT46WSCPbudrq4zhWMk6

customFields object[]

Array [

id stringrequired

Example:MgobCB14YMVKuE4Ka8p1

fieldValue objectrequired

The value of the custom field

oneOf
\

  • MOD1\
  • MOD2\
  • MOD3\
  • MOD4

    string

    object

    Array [

    string

    ]

    Array [

    object

    ]

    ]

followers array[]

{
  "opportunity": {
    "id": "yWQobCRIhRguQtD2llvk",
    "name": "testing",
    "monetaryValue": 500,
    "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
    "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
    "assignedTo": "zT46WSCPbudrq4zhWMk6",
    "status": "open",
    "source": "",
    "lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
    "lastStageChangeAt": "2021-08-03T04:55:17.355Z",
    "lastActionDate": "2021-08-03T04:55:17.355Z",
    "indexVersion": 1,
    "createdAt": "2021-08-03T04:55:17.355Z",
    "updatedAt": "2021-08-03T04:55:17.355Z",
    "contactId": "zT46WSCPbudrq4zhWMk6",
    "locationId": "zT46WSCPbudrq4zhW",
    "contact": {
      "id": "byMEV0NQinDhq8ZfiOi2",
      "name": "John Deo",
      "companyName": "Tesla Inc",
      "email": "john@deo.com",
      "phone": "+1202-555-0107",
      "tags": [\
        "string"\
      ]
    },
    "notes": [\
      [\
        null\
      ]\
    ],
    "tasks": [\
      [\
        null\
      ]\
    ],
    "calendarEvents": [\
      [\
        null\
      ]\
    ],
    "lostReasonId": "zT46WSCPbudrq4zhWMk6",
    "customFields": [\
      {\
        "id": "MgobCB14YMVKuE4Ka8p1",\
        "fieldValue": "string"\
      }\
    ],
    "followers": [\
      [\
        null\
      ]\
    ]
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/opportunities/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "First Opps",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "status": "open",
  "contactId": "mTkSCb1UBjb5tk4OvB69",
  "monetaryValue": 220,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "customFields": [\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": "9039160788"\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": [\
        "test",\
        "test2"\
      ]\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": {}\
    }\
  ]
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

Version — headerrequired

---2021-07-28

Body required

{
  "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "First Opps",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "status": "open",
  "contactId": "mTkSCb1UBjb5tk4OvB69",
  "monetaryValue": 220,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "customFields": [\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": "9039160788"\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": [\
        "test",\
        "test2"\
      ]\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": {}\
    }\
  ]
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Delete Opportunity

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/delete-opportunity/index.html

Skip to main content

Delete Opportunity

DELETE https://services.leadconnectorhq.com/opportunities/:id

Delete Opportunity

Requirements

Scope(s)

opportunities.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

id stringrequired

Opportunity Id

Example: yWQobCRIhRguQtD2llvk

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

succeded boolean

Example:true

{
  "succeded": true
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X DELETE 'https://services.leadconnectorhq.com/opportunities/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

id — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Opportunity

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/get-opportunity/index.html

Skip to main content

Get Opportunity

GET https://services.leadconnectorhq.com/opportunities/:id

Get Opportunity

Requirements

Scope(s)

opportunities.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

id stringrequired

Opportunity Id

Example: yWQobCRIhRguQtD2llvk

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

opportunity object

id string

Example:yWQobCRIhRguQtD2llvk

name string

Example:testing

monetaryValue number

Example:500

pipelineId string

Example:VDm7RPYC2GLUvdpKmBfC

pipelineStageId string

Example:e93ba61a-53b3-45e7-985a-c7732dbcdb69

assignedTo string

Example:zT46WSCPbudrq4zhWMk6

status string

Example:open

source string

Example:``

lastStatusChangeAt string

Example:2021-08-03T04:55:17.355Z

lastStageChangeAt string

Example:2021-08-03T04:55:17.355Z

lastActionDate string

Example:2021-08-03T04:55:17.355Z

indexVersion string

Example:1

createdAt string

Example:2021-08-03T04:55:17.355Z

updatedAt string

Example:2021-08-03T04:55:17.355Z

contactId string

Example:zT46WSCPbudrq4zhWMk6

locationId string

Example:zT46WSCPbudrq4zhW

contact object

id string

Example:byMEV0NQinDhq8ZfiOi2

name string

Example:John Deo

companyName string

Example:Tesla Inc

email string

Example:john@deo.com

phone string

Example:+1202-555-0107

tags string[]

notes array[]

tasks array[]

calendarEvents array[]

lostReasonId string

Example:zT46WSCPbudrq4zhWMk6

customFields object[]

Array [

id stringrequired

Example:MgobCB14YMVKuE4Ka8p1

fieldValue objectrequired

The value of the custom field

oneOf
\

  • MOD1\
  • MOD2\
  • MOD3\
  • MOD4

    string

    object

    Array [

    string

    ]

    Array [

    object

    ]

    ]

followers array[]

{
  "opportunity": {
    "id": "yWQobCRIhRguQtD2llvk",
    "name": "testing",
    "monetaryValue": 500,
    "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
    "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
    "assignedTo": "zT46WSCPbudrq4zhWMk6",
    "status": "open",
    "source": "",
    "lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
    "lastStageChangeAt": "2021-08-03T04:55:17.355Z",
    "lastActionDate": "2021-08-03T04:55:17.355Z",
    "indexVersion": 1,
    "createdAt": "2021-08-03T04:55:17.355Z",
    "updatedAt": "2021-08-03T04:55:17.355Z",
    "contactId": "zT46WSCPbudrq4zhWMk6",
    "locationId": "zT46WSCPbudrq4zhW",
    "contact": {
      "id": "byMEV0NQinDhq8ZfiOi2",
      "name": "John Deo",
      "companyName": "Tesla Inc",
      "email": "john@deo.com",
      "phone": "+1202-555-0107",
      "tags": [\
        "string"\
      ]
    },
    "notes": [\
      [\
        null\
      ]\
    ],
    "tasks": [\
      [\
        null\
      ]\
    ],
    "calendarEvents": [\
      [\
        null\
      ]\
    ],
    "lostReasonId": "zT46WSCPbudrq4zhWMk6",
    "customFields": [\
      {\
        "id": "MgobCB14YMVKuE4Ka8p1",\
        "fieldValue": "string"\
      }\
    ],
    "followers": [\
      [\
        null\
      ]\
    ]
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/opportunities/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

id — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Pipelines

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/get-pipelines/index.html

Skip to main content

Get Pipelines

GET https://services.leadconnectorhq.com/opportunities/pipelines

Get Pipelines

Requirements

Scope(s)

opportunities.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Query Parameters

locationId stringrequired

Example: ve9EPM428h8vShlRW1KT

Responses ​

  • 200
  • 400
  • 401

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

pipelines object[]

Array [

id string

Example:aWdODOBVOlH1RUFKWQke

name string

Example:new pipeline

stages array[]

showInFunnel boolean

Example:false

showInPieChart boolean

Example:true

locationId string

Example:dsjddjkndadqaja

]

{
  "pipelines": [\
    {\
      "id": "aWdODOBVOlH1RUFKWQke",\
      "name": "new pipeline",\
      "stages": [\
        [\
          null\
        ]\
      ],\
      "showInFunnel": false,\
      "showInPieChart": true,\
      "locationId": "dsjddjkndadqaja"\
    }\
  ]
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/opportunities/pipelines' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — queryrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Search Opportunities Advanced

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunities-advanced/index.html

Skip to main content

Search Opportunities

POST https://services.leadconnectorhq.com/opportunities/search

Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f

Requirements

Scope(s)

opportunities.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

  • application/json

Body required

locationId stringrequired

Location Id

Example:i2SpAtBVHSVea1sL6oah

query stringrequired

limit numberrequired

page numberrequired

searchAfter string[]required

additionalDetails objectrequired

notes booleanrequired

tasks booleanrequired

calendarEvents booleanrequired

unReadConversations booleanrequired

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

opportunities object[]

Array [

id string

Example:yWQobCRIhRguQtD2llvk

name string

Example:testing

monetaryValue number

Example:500

pipelineId string

Example:VDm7RPYC2GLUvdpKmBfC

pipelineStageId string

Example:e93ba61a-53b3-45e7-985a-c7732dbcdb69

assignedTo string

Example:zT46WSCPbudrq4zhWMk6

status string

Example:open

source string

Example:``

lastStatusChangeAt string

Example:2021-08-03T04:55:17.355Z

lastStageChangeAt string

Example:`2021-08-03T04:55:17.355Z`

lastActionDate string

Example:`2021-08-03T04:55:17.355Z`

indexVersion string

Example:`1`

createdAt string

Example:`2021-08-03T04:55:17.355Z`

updatedAt string

Example:`2021-08-03T04:55:17.355Z`

contactId string

Example:`zT46WSCPbudrq4zhWMk6`

locationId string

Example:`zT46WSCPbudrq4zhW`

contact object

id string

Example:`byMEV0NQinDhq8ZfiOi2`

name string

Example:`John Deo`

companyName string

Example:`Tesla Inc`

email string

Example:`john@deo.com`

phone string

Example:`+1202-555-0107`

tags string[]

notes array[]

tasks array[]

calendarEvents array[]

lostReasonId string

Example:`zT46WSCPbudrq4zhWMk6`

customFields object[]

Array [

id stringrequired

Example:`MgobCB14YMVKuE4Ka8p1`

fieldValue objectrequired

The value of the custom field

oneOf
\

  • MOD1\
  • MOD2\
  • MOD3\
  • MOD4

    string

    object

    Array [

    string

    ]

    Array [

    object

    ]

    ]

    followers array[]

    ]

total numberrequired

Example:100

aggregations object

{
  "opportunities": [\
    {\
      "id": "yWQobCRIhRguQtD2llvk",\
      "name": "testing",\
      "monetaryValue": 500,\
      "pipelineId": "VDm7RPYC2GLUvdpKmBfC",\
      "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",\
      "assignedTo": "zT46WSCPbudrq4zhWMk6",\
      "status": "open",\
      "source": "",\
      "lastStatusChangeAt": "2021-08-03T04:55:17.355Z",\
      "lastStageChangeAt": "2021-08-03T04:55:17.355Z",\
      "lastActionDate": "2021-08-03T04:55:17.355Z",\
      "indexVersion": 1,\
      "createdAt": "2021-08-03T04:55:17.355Z",\
      "updatedAt": "2021-08-03T04:55:17.355Z",\
      "contactId": "zT46WSCPbudrq4zhWMk6",\
      "locationId": "zT46WSCPbudrq4zhW",\
      "contact": {\
        "id": "byMEV0NQinDhq8ZfiOi2",\
        "name": "John Deo",\
        "companyName": "Tesla Inc",\
        "email": "john@deo.com",\
        "phone": "+1202-555-0107",\
        "tags": [\
          "string"\
        ]\
      },\
      "notes": [\
        [\
          null\
        ]\
      ],\
      "tasks": [\
        [\
          null\
        ]\
      ],\
      "calendarEvents": [\
        [\
          null\
        ]\
      ],\
      "lostReasonId": "zT46WSCPbudrq4zhWMk6",\
      "customFields": [\
        {\
          "id": "MgobCB14YMVKuE4Ka8p1",\
          "fieldValue": "string"\
        }\
      ],\
      "followers": [\
        [\
          null\
        ]\
      ]\
    }\
  ],
  "total": 100,
  "aggregations": {}
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/opportunities/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "locationId": "i2SpAtBVHSVea1sL6oah",
  "query": "string",
  "limit": 0,
  "page": 0,
  "searchAfter": [\
    "string"\
  ],
  "additionalDetails": {
    "notes": true,
    "tasks": true,
    "calendarEvents": true,
    "unReadConversations": true
  }
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

Version — headerrequired

---2021-07-28

Body required

{
  "locationId": "i2SpAtBVHSVea1sL6oah",
  "query": "string",
  "limit": 0,
  "page": 0,
  "searchAfter": [\
    "string"\
  ],
  "additionalDetails": {
    "notes": true,
    "tasks": true,
    "calendarEvents": true,
    "unReadConversations": true
  }
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Search Opportunity

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunity/index.html

Skip to main content

Search Opportunity

GET https://services.leadconnectorhq.com/opportunities/search

Search Opportunity

Requirements

Scope(s)

opportunities.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Query Parameters

q string

Example: john@deo.com

location_id stringrequired

Location Id

Example: i2SpAtBVHSVea1sL6oah

pipeline_id string

Pipeline Id

Example: bCkKGpDsyPP4peuKowkG

pipeline_stage_id string

stage Id

Example: 7915dedc-8f18-44d5-8bc3-77c04e994a10

contact_id string

Contact Id

Example: WFwVrSSjZ2CNHbZThQX2

status string

Possible values: [open, won, lost, abandoned, all]

assigned_to string

Example: 082goXVW3lIExEQPOnd3

campaignId string

Campaign Id

Example: Y2I9XM7aO1hncuSOlc9L

id string

Opportunity Id

Example: 123akv4LFn6C9frZoy3e

order string

Example: added_asc

endDate string

End date

Example: mm-dd-yyyy

startAfter string

Start After

Example: 1628008053263

startAfterId string

Start After Id

Example: UIaE1WjAwWKdlyD7osQI

date string

Start date

Example: mm-dd-yyyy

country string

Example: US

page number

Default value:1

limit number

Limit Per Page records count. will allow maximum up to 100 and default will be 20

Default value:20

getTasks boolean

get Tasks in contact

getNotes boolean

get Notes in contact

getCalendarEvents boolean

get Calender event in contact

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

opportunities object[]

Array [

id string

Example:yWQobCRIhRguQtD2llvk

name string

Example:testing

monetaryValue number

Example:500

pipelineId string

Example:VDm7RPYC2GLUvdpKmBfC

pipelineStageId string

Example:e93ba61a-53b3-45e7-985a-c7732dbcdb69

assignedTo string

Example:zT46WSCPbudrq4zhWMk6

status string

Example:open

source string

Example:``

lastStatusChangeAt string

Example:2021-08-03T04:55:17.355Z

lastStageChangeAt string

Example:`2021-08-03T04:55:17.355Z`

lastActionDate string

Example:`2021-08-03T04:55:17.355Z`

indexVersion string

Example:`1`

createdAt string

Example:`2021-08-03T04:55:17.355Z`

updatedAt string

Example:`2021-08-03T04:55:17.355Z`

contactId string

Example:`zT46WSCPbudrq4zhWMk6`

locationId string

Example:`zT46WSCPbudrq4zhW`

contact object

id string

Example:`byMEV0NQinDhq8ZfiOi2`

name string

Example:`John Deo`

companyName string

Example:`Tesla Inc`

email string

Example:`john@deo.com`

phone string

Example:`+1202-555-0107`

tags string[]

notes array[]

tasks array[]

calendarEvents array[]

lostReasonId string

Example:`zT46WSCPbudrq4zhWMk6`

customFields object[]

Array [

id stringrequired

Example:`MgobCB14YMVKuE4Ka8p1`

fieldValue objectrequired

The value of the custom field

oneOf
\

  • MOD1\
  • MOD2\
  • MOD3\
  • MOD4

    string

    object

    Array [

    string

    ]

    Array [

    object

    ]

    ]

    followers array[]

    ]

meta object

total number

Example:1

nextPageUrl string

Example:http://localhost:5066/opportunities/search?q=&location_id=ve9EPM428h8vShlRW1KT&pipeline_id=&pipeline_stage_id=&status=&assigned_to+=&campaignId=&id=&order=&endDate=&startAfter=1625203104328&startAfterId=yWQobCRIhRguQtD2llvk&date=&limit=1&country=&page=1

startAfterId string

Example:yWQobCRIhRguQtD2llvk

startAfter number

Example:1625203104328

currentPage number

Example:2

nextPage number

Example:3

prevPage number

Example:1

aggregations object

{
  "opportunities": [\
    {\
      "id": "yWQobCRIhRguQtD2llvk",\
      "name": "testing",\
      "monetaryValue": 500,\
      "pipelineId": "VDm7RPYC2GLUvdpKmBfC",\
      "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",\
      "assignedTo": "zT46WSCPbudrq4zhWMk6",\
      "status": "open",\
      "source": "",\
      "lastStatusChangeAt": "2021-08-03T04:55:17.355Z",\
      "lastStageChangeAt": "2021-08-03T04:55:17.355Z",\
      "lastActionDate": "2021-08-03T04:55:17.355Z",\
      "indexVersion": 1,\
      "createdAt": "2021-08-03T04:55:17.355Z",\
      "updatedAt": "2021-08-03T04:55:17.355Z",\
      "contactId": "zT46WSCPbudrq4zhWMk6",\
      "locationId": "zT46WSCPbudrq4zhW",\
      "contact": {\
        "id": "byMEV0NQinDhq8ZfiOi2",\
        "name": "John Deo",\
        "companyName": "Tesla Inc",\
        "email": "john@deo.com",\
        "phone": "+1202-555-0107",\
        "tags": [\
          "string"\
        ]\
      },\
      "notes": [\
        [\
          null\
        ]\
      ],\
      "tasks": [\
        [\
          null\
        ]\
      ],\
      "calendarEvents": [\
        [\
          null\
        ]\
      ],\
      "lostReasonId": "zT46WSCPbudrq4zhWMk6",\
      "customFields": [\
        {\
          "id": "MgobCB14YMVKuE4Ka8p1",\
          "fieldValue": "string"\
        }\
      ],\
      "followers": [\
        [\
          null\
        ]\
      ]\
    }\
  ],
  "meta": {
    "total": 1,
    "nextPageUrl": "http://localhost:5066/opportunities/search?q=&location_id=ve9EPM428h8vShlRW1KT&pipeline_id=&pipeline_stage_id=&status=&assigned_to+=&campaignId=&id=&order=&endDate=&startAfter=1625203104328&startAfterId=yWQobCRIhRguQtD2llvk&date=&limit=1&country=&page=1",
    "startAfterId": "yWQobCRIhRguQtD2llvk",
    "startAfter": 1625203104328,
    "currentPage": 2,
    "nextPage": 3,
    "prevPage": 1
  },
  "aggregations": {}
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/opportunities/search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

location_id — queryrequired

Version — headerrequired

---2021-07-28

Show optional parameters

q — query

pipeline_id — query

pipeline_stage_id — query

contact_id — query

status — query

---openwonlostabandonedall

assigned_to — query

campaignId — query

id — query

order — query

endDate — query

startAfter — query

startAfterId — query

date — query

country — query

page — query

limit — query

getTasks — query

---truefalse

getNotes — query

---truefalse

getCalendarEvents — query

---truefalse

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Update Opportunity

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/update-opportunity/index.html

Skip to main content

Update Opportunity

PUT https://services.leadconnectorhq.com/opportunities/:id

Update Opportunity

Requirements

Scope(s)

opportunities.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

id stringrequired

Opportunity Id

Example: yWQobCRIhRguQtD2llvk

  • application/json

Body required

pipelineId string

pipeline Id

Example:bCkKGpDsyPP4peuKowkG

name string

Example:First Opps

pipelineStageId string

Example:7915dedc-8f18-44d5-8bc3-77c04e994a10

status string

Possible values: [open, won, lost, abandoned, all]

monetaryValue number

Example:220

assignedTo string

Example:082goXVW3lIExEQPOnd3

customFields object[]

Update custom fields to opportunities.

Array [

anyOf
\

  • customFieldsInputStringSchema\
  • customFieldsInputArraySchema\
  • customFieldsInputObjectSchema

    id string

    Pass either id or key of custom field

    Example:6dvNaf7VhkQ9snc5vnjJ

    key string

    Pass either id or key of custom field

    Example:my_custom_field

    field_value string

    Example:9039160788

    id stringrequired

    Example:6dvNaf7VhkQ9snc5vnjJ

    key string

    Example:my_custom_field

    field_value string[]

    Example:["test","test2"]

    id stringrequired

    Example:6dvNaf7VhkQ9snc5vnjJ

    key string

    Example:my_custom_field

    field_value object

    Example:{}

    ]

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

opportunity object

id string

Example:yWQobCRIhRguQtD2llvk

name string

Example:testing

monetaryValue number

Example:500

pipelineId string

Example:VDm7RPYC2GLUvdpKmBfC

pipelineStageId string

Example:e93ba61a-53b3-45e7-985a-c7732dbcdb69

assignedTo string

Example:zT46WSCPbudrq4zhWMk6

status string

Example:open

source string

Example:``

lastStatusChangeAt string

Example:2021-08-03T04:55:17.355Z

lastStageChangeAt string

Example:2021-08-03T04:55:17.355Z

lastActionDate string

Example:2021-08-03T04:55:17.355Z

indexVersion string

Example:1

createdAt string

Example:2021-08-03T04:55:17.355Z

updatedAt string

Example:2021-08-03T04:55:17.355Z

contactId string

Example:zT46WSCPbudrq4zhWMk6

locationId string

Example:zT46WSCPbudrq4zhW

contact object

id string

Example:byMEV0NQinDhq8ZfiOi2

name string

Example:John Deo

companyName string

Example:Tesla Inc

email string

Example:john@deo.com

phone string

Example:+1202-555-0107

tags string[]

notes array[]

tasks array[]

calendarEvents array[]

lostReasonId string

Example:zT46WSCPbudrq4zhWMk6

customFields object[]

Array [

id stringrequired

Example:MgobCB14YMVKuE4Ka8p1

fieldValue objectrequired

The value of the custom field

oneOf
\

  • MOD1\
  • MOD2\
  • MOD3\
  • MOD4

    string

    object

    Array [

    string

    ]

    Array [

    object

    ]

    ]

followers array[]

{
  "opportunity": {
    "id": "yWQobCRIhRguQtD2llvk",
    "name": "testing",
    "monetaryValue": 500,
    "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
    "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
    "assignedTo": "zT46WSCPbudrq4zhWMk6",
    "status": "open",
    "source": "",
    "lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
    "lastStageChangeAt": "2021-08-03T04:55:17.355Z",
    "lastActionDate": "2021-08-03T04:55:17.355Z",
    "indexVersion": 1,
    "createdAt": "2021-08-03T04:55:17.355Z",
    "updatedAt": "2021-08-03T04:55:17.355Z",
    "contactId": "zT46WSCPbudrq4zhWMk6",
    "locationId": "zT46WSCPbudrq4zhW",
    "contact": {
      "id": "byMEV0NQinDhq8ZfiOi2",
      "name": "John Deo",
      "companyName": "Tesla Inc",
      "email": "john@deo.com",
      "phone": "+1202-555-0107",
      "tags": [\
        "string"\
      ]
    },
    "notes": [\
      [\
        null\
      ]\
    ],
    "tasks": [\
      [\
        null\
      ]\
    ],
    "calendarEvents": [\
      [\
        null\
      ]\
    ],
    "lostReasonId": "zT46WSCPbudrq4zhWMk6",
    "customFields": [\
      {\
        "id": "MgobCB14YMVKuE4Ka8p1",\
        "fieldValue": "string"\
      }\
    ],
    "followers": [\
      [\
        null\
      ]\
    ]
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X PUT 'https://services.leadconnectorhq.com/opportunities/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "pipelineId": "bCkKGpDsyPP4peuKowkG",
  "name": "First Opps",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "status": "open",
  "monetaryValue": 220,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "customFields": [\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": "9039160788"\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": [\
        "test",\
        "test2"\
      ]\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": {}\
    }\
  ]
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

id — pathrequired

Version — headerrequired

---2021-07-28

Body required

{
  "pipelineId": "bCkKGpDsyPP4peuKowkG",
  "name": "First Opps",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "status": "open",
  "monetaryValue": 220,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "customFields": [\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": "9039160788"\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": [\
        "test",\
        "test2"\
      ]\
    },\
    {\
      "id": "6dvNaf7VhkQ9snc5vnjJ",\
      "key": "my_custom_field",\
      "field_value": {}\
    }\
  ]
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Update Opportunity Status

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/update-opportunity-status/index.html

Skip to main content

Update Opportunity Status

PUT https://services.leadconnectorhq.com/opportunities/:id/status

Update Opportunity Status

Requirements

Scope(s)

opportunities.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

id stringrequired

Opportunity Id

Example: yWQobCRIhRguQtD2llvk

  • application/json

Body required

status stringrequired

Possible values: [open, won, lost, abandoned, all]

lostReasonId string

lost reason Id

Example:CLu7BaljjqrEjBGKTNNe

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

succeded boolean

Example:true

{
  "succeded": true
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X PUT 'https://services.leadconnectorhq.com/opportunities/:id/status' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "status": "open",
  "lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

id — pathrequired

Version — headerrequired

---2021-07-28

Body required

{
  "status": "open",
  "lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Upsert Opportunity

Source: https://marketplace.gohighlevel.com/docs/ghl/opportunities/upsert-opportunity/index.html

Skip to main content

Upsert Opportunity

POST https://services.leadconnectorhq.com/opportunities/upsert

Upsert Opportunity

Requirements

Scope(s)

opportunities.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

  • application/json

Body required

id string

opportunityId

Example:yWQobCRIhRguQtD2llvk

pipelineId stringrequired

pipeline Id

Example:bCkKGpDsyPP4peuKowkG

locationId stringrequired

locationId

Example:CLu7BaljjqrEjBGKTNNe

followers string[]required

contactId

Example:LiKJ2vnRg5ETM8Z19K7

isRemoveAllFollowers booleanrequired

isRemoveAllFollowers

Example:true

followersActionType stringrequired

followers action type

Possible values: [add, remove]

Example:add

name string

name

Example:opportunity name

status string

Possible values: [open, won, lost, abandoned, all]

pipelineStageId string

Example:7915dedc-8f18-44d5-8bc3-77c04e994a10

monetaryValue number

Example:220

assignedTo string

Example:082goXVW3lIExEQPOnd3

lostReasonId string

lost reason Id

Example:CLu7BaljjqrEjBGKTNNe

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

opportunity objectrequired

Updated / New Opportunity

new booleanrequired

Example:true

{
  "opportunity": {},
  "new": true
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: opportunities.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/opportunities/upsert' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "id": "yWQobCRIhRguQtD2llvk",
  "pipelineId": "bCkKGpDsyPP4peuKowkG",
  "locationId": "CLu7BaljjqrEjBGKTNNe",
  "followers": "LiKJ2vnRg5ETM8Z19K7",
  "isRemoveAllFollowers": true,
  "followersActionType": "add",
  "name": "opportunity name",
  "status": "open",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "monetaryValue": 220,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

Version — headerrequired

---2021-07-28

Body required

{
  "id": "yWQobCRIhRguQtD2llvk",
  "pipelineId": "bCkKGpDsyPP4peuKowkG",
  "locationId": "CLu7BaljjqrEjBGKTNNe",
  "followers": "LiKJ2vnRg5ETM8Z19K7",
  "isRemoveAllFollowers": true,
  "followersActionType": "add",
  "name": "opportunity name",
  "status": "open",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "monetaryValue": 220,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!