Update Organization

patch

https://organization/v1/organizations/{id}

Update Organization

Performs partial update, if a field is specified in the request it will be updated

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
<customAttribute1>	<customAttribute1Type>	false	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	false	Regular custom attribute N value
_description	string	false	A description, can be up to 5000 characters long	Lorem Ipsum
_headquarters	object	false
_headquarters.address1	string	false	An address	11 Main St.
_headquarters.address2	string	false	An address's specifics	Entry B, Apartment 1
_headquarters.city	string	false	A city	Boston
_headquarters.countryCode	string	true(*)	A 2-letter country code defined in ISO-3166	US
_headquarters.state	string	false	A state	Massachusetts
_headquarters.zipCode	string	false	A zipcode	02101
_locale	string	false	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_name	string	false	An organization's name	Example Inc.
_phone	string	false	An E.164 formatted phone number	+12345678901
_timezone	string	false	A java time zone supported by the java runtime environment	Europe/Oslo
Path Parameters:

Parameter	Type	Mandatory	Description	Example
id	string	true	Organization ID that needs to be updated	3fa85f64-5717-4562-b3fc-2c963f66afa6
Query Parameters:

Parameter	Type	Mandatory	Description	Example
includeReferencers	boolean	false	Optional query parameter that controls whether the response should include referencers metadata. When set to true, the response will contain an additional `_referencers` JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.). If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments. Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

This API requires ORGANIZATION_UPDATE_ORGANIZATION permission(s).

Path Params

uuid

required

Organization ID that needs to be updated

Query Params

includeReferencers

boolean

Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

Body Params

_name

string

length between 1 and 32

An organization's name

_description

string

A description, can be up to 5000 characters long

_headquarters

object

_phone

string

An E.164 formatted phone number

_timezone

string

A java time zone supported by the java runtime environment

_locale

string

Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

Responses

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_caption	string
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_description	string	A description, can be up to 5000 characters long	Lorem Ipsum
_headquarters	object
_headquarters.address1	string	An address	11 Main St.
_headquarters.address2	string	An address's specifics	Entry B, Apartment 1
_headquarters.city	string	A city	Boston
_headquarters.countryCode	string	A 2-letter country code defined in ISO-3166	US
_headquarters.state	string	A state	Massachusetts
_headquarters.zipCode	string	A zipcode	02101
_id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_locale	string	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_name	string	An organization's name	Example Inc.
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.template	object
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateName	string	The name of the referenced entity template
_phone	string	An E.164 formatted phone number	+12345678901
_primaryAdministrator	object
_primaryAdministrator.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_primaryAdministrator.name	string	The caption of the referenced entity
_primaryAdministrator.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_primaryAdministrator.parentEntityId	string	The id of the parent entity (appears only for child entities)
_primaryAdministrator.template	object
_primaryAdministrator.template.displayName	string	The display name of the template
_primaryAdministrator.template.id	string	The id of the template
_primaryAdministrator.template.name	string	The name of the template
_primaryAdministrator.template.parentTemplate	object
_primaryAdministrator.template.parentTemplate.displayName	string
_primaryAdministrator.template.parentTemplate.id	string
_primaryAdministrator.template.parentTemplate.name	string
_primaryAdministrator.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_primaryAdministrator.templateName	string	The name of the referenced entity template
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_template	object
_template.displayName	string	The display name of the template
_template.id	string	The id of the template
_template.name	string	The name of the template
_template.parentTemplate	object
_template.parentTemplate.displayName	string
_template.parentTemplate.id	string
_template.parentTemplate.name	string
_timezone	string	A java time zone supported by the java runtime environment	Europe/Oslo

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

403Code : OWNER_ORGANIZATION_ID_MISMATCH, Details: [providedOwnerOrganizationId, templateOwnerOrganizationId] Code : ALREADY_REFERENCED_UNIQUELY, Details: [attributeName, referencedEntityId, referencingEntityId, referencingTemplateId] Code : ACCESS_DENIED, Details: []

404Code : ORGANIZATION_NOT_FOUND, Details: [id] Code : REFERENCE_CONFIGURATION_ENTITY_NOT_FOUND, Details: [attributeName, entityId]

409Code : ORGANIZATION_ALREADY_EXIST, Details: [name]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []