HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Sub-operators / Create

post
https://{tenantUrl}/public-api/resources/sub-operators/v2.0

Create a new sub-operator

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

At least one of name or translatedName must be provided. Supplying both is rejected with a 422 response. When translatedName is used it must carry an en entry.

A deprecated field and its translated sibling are mutually exclusive: name/translatedName, address/translatedAddress, city/translatedCity and region/translatedRegion may each be sent one at a time, never both.

string
required
length ≤ 255

Official business name for legal/financial purposes

string
length ≤ 255

External system identifier for integration purposes

string
length ≤ 255

Company registration number

string
length ≤ 255

Tax identification number

string
enum

ISO 3166-1 alpha-2 country code

enum

State/province code for countries with predefined states (US, CA, AU, UM, RO). Mutually exclusive with region.

This is a controlled code, not a translation: it is the same string in every language, has no translated sibling, and is not affected by the locale of any other field on this resource.

When the country is US.

string
length ≤ 255

Postal/ZIP code

string
length ≤ 255

Primary contact person name

string
length ≤ 255

Contact phone number

string
length ≤ 255

Contact email address

string
length ≤ 255

Email address for receiving fault notifications

string

Long-form business context and operational notes

capabilities
object
partnerIds
array of integers

List of associated partner IDs

partnerIds
translatedName
array of objects
length ≥ 1

Display name of the sub-operator per locale. Whenever this field is submitted — on both create and update — the array must contain an en entry. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the name: locales absent from the array are cleared. Omit the field to leave every existing locale untouched. An empty array is rejected on both create and update — the name cannot be cleared.

Cannot be provided together with the deprecated name.

translatedName
translatedAddress
array of objects

Street address of the sub-operator per locale. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the address: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all.

Cannot be provided together with the deprecated address.

translatedAddress
translatedCity
array of objects

City of the sub-operator per locale. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the city: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all.

Cannot be provided together with the deprecated city.

translatedCity
translatedRegion
array of objects

Region of the sub-operator per locale. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the region: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all.

Rejected when the sub-operator's country supports states (US, CA, AU, UM, RO) — state applies instead and is not translatable. Cannot be provided together with the deprecated region.

translatedRegion
string
length ≤ 255
deprecated

This property is deprecated. Use translatedName instead.

The value is written to the English (en) locale only. Cannot be provided together with translatedName.

Display name of the sub-operator.

string
length ≤ 255
deprecated

This property is deprecated. Use translatedCity instead.

The value is written to the English (en) locale only. Cannot be provided together with translatedCity.

City name

string | null
deprecated

This property is deprecated. Use translatedRegion instead, when the sub-operator's country does not support states. When the country is one of US, CA, AU, UM or RO, state applies instead of both region and translatedRegion.

The value is written to the English (en) locale only. Cannot be provided together with translatedRegion.

Region name for countries without predefined states. Mutually exclusive with state.

string
length ≤ 255
deprecated

This property is deprecated. Use translatedAddress instead.

The value is written to the English (en) locale only. Cannot be provided together with translatedAddress.

Street address

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?