Skip to main content
POST
Add a territory to a publisher
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Validates territory-basics, PR/MR/SR share totals, and checks for overlapping territory coverage on the publisher before and after creation.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Body

application/json
territoryCode
string
required
prShare
number
required
Required range: 0 <= x <= 100
mrShare
number
required
Required range: 0 <= x <= 100
srShare
number
required
Required range: 0 <= x <= 100
startDate
string<date-time>
required
inclusionExclusion
enum<string>
Available options:
I,
E
endDate
string<date-time> | null

Response

Territory created.

id
string<uuid>
TenantId
integer
publisherId
string<uuid>
territoryCode
string

ISO territory code or 'WW' for worldwide.

Example:

"US"

inclusionExclusion
enum<string>
default:I
Available options:
I,
E
prShare
number
Required range: 0 <= x <= 100
mrShare
number
Required range: 0 <= x <= 100
srShare
number
Required range: 0 <= x <= 100
startDate
string<date-time>
endDate
string<date-time> | null
rights
object[]
formula
string | null

CWR 2.2+ territory formula, e.g. "2136 BUT NOT 2250". At most one exclusion marker (EX/X).

postTermCollection
boolean
default:false
assignmentType
enum<string> | null
Available options:
DIRECT,
SUB,
ADMIN
licenseType
enum<string> | null
Available options:
EXCLUSIVE,
NON-EXCLUSIVE
agreementId
string<uuid> | null
createdAt
string<date-time>
updatedAt
string<date-time>