ServiceTerritory | SOAP API Developer Guide

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Field Service Lightning must be enabled.

Fields

Field Name	Details
Address	Type address Properties Filter Description An address to associate with the territory. You may want to list the address of the territory’s headquarters.
City	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the associated address. Maximum length is 40 characters.
Country	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country to associate with the territory. Maximum length is 80 characters.
Description	Type textarea Properties Create, Nillable, Update Description The description of the territory.
GeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. This field is available in the API only. Note
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the service territory is meant to be used. If a territory is inactive, you can’t add members to it or link it to work orders, work order line items, or service appointments.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the territory was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the territory was last viewed.
Latitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address associated with the territory. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. This field is available in the API only. Note
Longitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address associated with the territory. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. This field is available in the API only. Note
Name	Type string Properties Create, Filter, Group, Sort, Update Description The name of the territory.
OperatingHoursId	Type reference Properties Create, Filter, Group, Sort, Update Description The territory’s operating hours, which indicate when service appointments within the territory can occur. Service resources who are members of a territory automatically inherit the territory’s operating hours unless different hours are specified on the resource record.
ParentTerritoryId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The territory’s parent service territory, if it has one. For example, a `Northern California` territory can have a `State of California` territory as its parent. A service territory hierarchy can contain up to 500 territories.
PostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address associated with the territory. Maximum length is 20 characters.
State	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address associated with the territory. Maximum length is 80 characters.
Street	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name of the address associated with the territory.
TopLevelTerritoryId	Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level territory in a hierarchy of service territories. Depending on where a territory lies in the hierarchy, its top-level territory might be the same as its parent.

Usage

View service territories on the Service Territories tab. You can also view a service resource’s territories on the Service Territories related list on the resource detail page.

If you want to use service territories, determine which territories you need to create. Depending on how your business works, you may decide to create territories based on cities, counties, or other factors. If you plan to build out a hierarchy of service territories, create the highest-level territories first.

Create service territories from the Service Territories tab in Salesforce. After you create a territory, you can add members to it via the Service Territory Members related list. Service territory members are resources who work within the territory, and associating them with a territory ensures that they’re assigned to appointments near their home base.

For example, you can create a hierarchy of territories to represent the areas where your team works in California. Include a top-level territory named California, three child territories named Northern California, Central California, and Southern California, and a series of third-level territories corresponding to California counties. Assign service resources to each county territory to indicate who is available to work in that county.