Sales API Reference
API Reference/Sales

Sales

For authentication instructions, see API overview.

Endpoints

get/api/v2/sales-stages
post/api/v2/sales-stages
get/api/v2/sales-stages/:id
put/api/v2/sales-stages/:id
patch/api/v2/sales-stages/:id
delete/api/v2/sales-stages/deleted/:id
put/api/v2/sales-stages/multiple
get

List all sales stages

Returns a list of sales stages. The sales stages 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/sales-stages

Response

No response schema
post

Create sales stages

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

Request body

  • stageNamestring
  • descriptionstring
  • probabilitynumber
  • typestring
  • forecastCategorystring
  • chartColorstring
  • ordernumber

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/sales-stages \
	-d 'stageName="stage1"' \
	-d 'description="description1"' \
	-d 'probability=0.75' \
	-d 'type="Closed-Lost"' \
	-d 'forecastCategory="Omitted"' \
	-d 'chartColor="#FF5733"' \
	-d 'order=6'

Response

No response schema
get

Retrieve sales stages

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

Path parameters

  • idstring

    ID of the sales stage

Request

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

Response

No response schema
put

Update sales stages

Path parameters

  • idstring

    ID of the sales stage

Request body

  • stageNamestring
  • descriptionstring
  • probabilitynumber
  • typestring
  • forecastCategorystring
  • chartColorstring
  • ordernumber

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/sales-stages/:id \
	-d 'stageName="stage1"' \
	-d 'description="description1"' \
	-d 'probability=0.75' \
	-d 'type="Closed-Lost"' \
	-d 'forecastCategory="Omitted"' \
	-d 'chartColor="#FF5733"' \
	-d 'order=6'

Response

No response schema
patch

Update sales stages soft

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

Path parameters

  • idstring

    ID of the sales stage

Request

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

Response

No response schema
delete

Delete sales stages

Path parameters

  • idstring

    ID of the sales stage

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/sales-stages/deleted/:id

Response

No response schema
put

Update sales stages update

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/sales-stages/multiple

Response

No response schema