Update an instance of salesTerritories

patch

/services/rest/connect/latest/salesTerritories/{id}

Request

Path Parameters
Body ()
A specific geographical sales region
Root Schema : salesTerritories
Type: object
A specific geographical sales region
Show Source
Nested Schema : namedIDs-salesTerritories-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : salesTerritories-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-salesTerritories-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Response

Default Response

Examples

Use the PATCH operation with the following syntax to partially update a sales territory object:

https://your_site_interface/services/rest/connect/version/salesTerritories/territory_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12

Request body example

{
"parent":
    {
    "id":9
    }
}

Response example

The status 200 OK is returned. Then retrieving the data for sales territory 12:

https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12

returns the following:

{
  "id": 12,
  "lookupName": "Quebec",
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12/
         adminVisibleInterfaces"
      }
    ]
  },
  "comment": null,
  "disabled": false,
  "displayOrder": 2,
  "name": "Quebec",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12/names"
      }
    ]
  },
  "parent": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/9"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/9"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesTerritories",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "territoryHierarchy": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12/territoryHierarchy"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/12"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesTerritories",
      "mediaType": "application/schema+json"
    }
  ]
}

Note:

The Quebec sales territory is now under Canada.