Sales API Reference
API Reference/Sales

Sales

For authentication instructions, see API overview.

Endpoints

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

List all sales territories

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

Response

No response schema
post

Create sales territories

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

Request body

  • salesTerritoriesarray

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-territories \
	-d 'salesTerritories="array"'

Response

No response schema
get

Retrieve sales territories

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

Path parameters

  • idstring

    ID of the sales territory

Request

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

Response

No response schema
put

Update sales territories

Path parameters

  • idstring

    ID of the sales territory

Request body

  • salesTerritoriesarray

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-territories/:id \
	-d 'salesTerritories="array"'

Response

No response schema
patch

Update sales territories soft

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

Path parameters

  • idstring

    ID of the sales territory

Request

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

Response

No response schema
delete

Delete sales territories

Path parameters

  • idstring

    ID of the sales territory

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

Response

No response schema