Opportunity

patch

https://api.marketcircle.net/v1/opportunities/{id}

Edit a Opportunity

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Opportunity for a list of attributes which are supported for opportunities. Only attributes marked as Read-Write can be set using this endpoint.

Path Params

int32

required

opportunity id

Body Params

name

string

Name of the Opportunity

state

string

The current state of the opportunity.

type

string

probability

int32

Likelihood of the winning the opportunity (percentage)

forecasted

date

Expected closing date of the opportunity. Example: 2025-03-31T11:28:38.000Z

start

date

Start date of the opportunity Example: 2025-03-04T13:04:14.407Z

end

date

End date of the opportunity Example: 2025-03-31T11:31:33.000Z

details

string

Details of the opportunity

priority

int32

Priority of the opportunity. Must be an integer value between 0 (lowest priority) and 10 (highest priority)

category

string

Category assigned to the opportunity

keywords

array of strings

List of Keywords

keywords

extra_fields

object

Each extra field will use its default name even if you have customized it

contacts

array of objects

List of Contact Roles Example: /v1/contacts/1001

contacts

companies

array of objects

List of Company Roles Example: /v1/companies/1001

companies

appointments

array of objects

List of Appointments Example: /v1/appointments/1001

appointments

forms

array of objects

List of Forms Example: /v1/forms/1001

forms

notes

array of objects

List of Notes Example: /v1/notes/1001

notes

tasks

array of objects

List of Tasks Example: /v1/tasks/1001

tasks

groups

array of objects

List of Groups Example: /v1/groups/1001

groups

owner

string

trashed

boolean

You can use this to untrash an object by setting it to false. true will do nothing, use delete for that.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400