organizationCreate Mutation

Creates a new organization.

Input Argument

organizationCreate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

businessUnit (Boolean)

Whether the organization needs to be treated as a separate entity from a reporting perspective. This checkbox is only available for internal organizations.

businessUnitOrganizationId (ID)

Refers to itself if the organization is a business unit, or refers to the business unit that the organization belongs to.

clientMutationId (String)

A unique identifier for the client performing the mutation.

customFields ([CustomFieldInput!])

Values for custom fields to be used by the UI Extension that is linked to the record.

customFieldsAttachments ([AttachmentInput!])

The attachments used in the custom fields' values.

disabled (Boolean)

Whether the organization may no longer be related to other records.

endUserPrivacy (Boolean)

Whether end users from this organization should be prevented from seeing information of other end users.

financialID (String)

The unique identifier by which the organization is known in the financial system.

managerId (ID)

The manager of the organization.

name (String!)

The full name of the organization.

newAddresses ([AddressInput!])

New or updated addresses of the organization.

newContacts ([ContactInput!])

New or updated contacts of the organization.

parentId (ID)

The organization's parent organization.

pictureUri (String)

The hyperlink to the image file for the record.

region (String)

Which region the organization belongs to. It is possible to select a previously entered region name or to enter a new one. The Region field of a business unit's child organizations cannot be modified, as it is automatically set to the same value as the Region field of the business unit. Examples of commonly used region names are:

  • Asia Pacific (APAC)
  • Europe, Middle East & Africa (EMEA)
  • North America (NA)
remarks (String)

Any additional information about the organization that might prove useful.

remarksAttachments ([AttachmentInput!])

The attachments used in the remarks field.

source (String)

An identifier for the client application submitting the resource or the name of an external system.

sourceID (String)

The unique identifier of the resource in an external system.

substituteId (ID)

The person who acts as the substitute of the organization's manager.

timeAllocationIds ([ID!])

Time allocations of the organization.

uiExtensionId (ID)

UI extension that is to be applied to the record.

Return Fields

clientMutationId (String)

A unique identifier for the client performing the mutation.

errors ([ValidationError!])

Errors encountered during the mutation.

organization (Organization)

Record after mutation.