Skip to navigation
API ReferenceTerritories

UpdateTerritory

UpdateTerritory changes the name or the states that update_mask names.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

idstringRequiredformat: "uuid"1-36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.

Headers

Edulead-TeamstringRequired

Query parameters

update_maskstringOptional
Which fields of the resource to change. Fields not listed keep their values.

Request

This endpoint expects an object.
idstringOptional<=36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
namestringOptional<=100 characters

The territory’s name, trimmed; required on create and when updated. Names need not be unique.

stateslist of enumsOptional

Two-letter codes of the states it covers (the 50 states and DC), upper case, distinct, in the order given; may be empty.

colorintegerOptional0-8
The display color, 1 to 8, chosen on create as the one the team's territories use least.
creator_idstringOptional<=255 characters

The user or API key that created it; “system” for the default regions Edulead added.

create_timedatetimeOptional
When Edulead created the resource.
update_timedatetimeOptional
When any field last changed.

Response

Success
territoryobjectOptional
Territory is a named set of US states.