Selling API Reference
API Reference/Selling

Selling

For authentication instructions, see API overview.

Endpoints

get/api/v2/selling_opportunities
post/api/v2/selling_opportunities
get/api/v2/selling_opportunities/:id
put/api/v2/selling_opportunities/:id
patch/api/v2/selling_opportunities/:id
delete/api/v2/selling_opportunities/deleted/:id
get

List all selling opportunities

Returns a list of selling opportunities. The selling opportunities are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/selling_opportunities

Response

No response schema
post

Create selling opportunities

Create selling opportunities. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • ownerstring
  • assigneestring
  • opportunityDescriptionstring
  • taskIdstring
  • currentStagestring
  • forecastCategorystring
  • statusstring
  • unitsarray
  • notesarray
  • documentsarray
  • opportunityTypestring
  • opportunitySourcestring
  • opportunityRatingnumber

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/selling_opportunities \
	-d 'owner="64620af474e3cd5d51113a50"' \
	-d 'assignee="63ea49062953ae07682c83f3"' \
	-d 'opportunityDescription="Interested in purchasing a new property"' \
	-d 'taskId="6391eec6049e9c361e5801fe"' \
	-d 'currentStage="stage1"' \
	-d 'forecastCategory="category1"' \
	-d 'status="active"' \
	-d 'units="array"' \
	-d 'notes="array"' \
	-d 'documents="array"' \
	-d 'opportunityType="new"' \
	-d 'opportunitySource="website"' \
	-d 'opportunityRating=4'

Response

No response schema
get

Retrieve selling opportunities

Returns a single selling opportunitie, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the selling opportunity

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/selling_opportunities/:id

Response

No response schema
put

Update selling opportunities

Path parameters

  • idstring

    ID of the selling opportunity

Request body

  • ownerstring
  • assigneestring
  • opportunityDescriptionstring
  • taskIdstring
  • currentStagestring
  • forecastCategorystring
  • statusstring
  • unitsarray
  • notesarray
  • documentsarray
  • opportunityTypestring
  • opportunitySourcestring
  • opportunityRatingnumber

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/selling_opportunities/:id \
	-d 'owner="64620af474e3cd5d51113a50"' \
	-d 'assignee="63ea49062953ae07682c83f3"' \
	-d 'opportunityDescription="Interested in purchasing a new property"' \
	-d 'taskId="6391eec6049e9c361e5801fe"' \
	-d 'currentStage="stage1"' \
	-d 'forecastCategory="category1"' \
	-d 'status="active"' \
	-d 'units="array"' \
	-d 'notes="array"' \
	-d 'documents="array"' \
	-d 'opportunityType="new"' \
	-d 'opportunitySource="website"' \
	-d 'opportunityRating=4'

Response

No response schema
patch

Update selling opportunities soft

Update selling opportunities soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the selling opportunity

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/selling_opportunities/:id

Response

No response schema
delete

Delete selling opportunities

Path parameters

  • idstring

    ID of the selling opportunity

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/selling_opportunities/deleted/:id

Response

No response schema