HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Sub-operators / Update

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

Update an existing sub-operator. Only provided fields are updated - omitted fields retain their current values.
Send null for nullable fields to explicitly clear their values.

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

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. Supplying both is rejected with a 422 response.

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

Official business name for legal/financial purposes

string | null

External system identifier. Send null to clear.

string | null

Company registration number. Send null to clear.

string | null

Tax identification number. Send null to clear.

string | null
enum

ISO 3166-1 alpha-2 country code. Send null to clear.

string | null
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. Send null to clear the English (en) value only — every other locale is left untouched. Use translatedCity to clear other locales.

enum

State/province code for countries with predefined states (US, CA, AU, UM, RO). Send null to clear.

When the country is US.

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. Send null to clear the English (en) value only — every other locale is left untouched. Use translatedRegion to clear other locales.

string | null

Postal/ZIP code. Send null to clear.

string | null
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. Send null to clear the English (en) value only — every other locale is left untouched. Use translatedAddress to clear other locales.

string | null

Primary contact person name. Send null to clear.

string | null

Contact phone number. Send null to clear.

string | null

Contact email address. Send null to clear.

string | null

Email address for receiving fault notifications. Must be a valid email format. Send null to clear.

string | null

Long-form business context and operational notes. Send null to clear.

capabilities
object
partnerIds
array of integers

List of partner IDs to associate. Replaces existing associations.

partnerIds
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?