Multi-entity: Create an entity

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Creates an entity in a multi-entity hierarchy.

User Access Permission

You must make the call as a global entity administrator.

Notes

  • We recommend that you assign only one administrator to manage the entity hierarchy, because an administrator of the global entity by default can only access to the entities that are created by themselves.
Request
header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Request Body schema: application/json
required
displayName
string <= 255 characters

The display name of the entity that is shown in the Zuora UI and APIs

Note: If you do not specify the display name in the request, the entity name is used as the display name.

locale
required
string

The locale that is used in this entity.

name
required
string <= 255 characters

The name of the entity that is the entity identifier and is unique across all entities in a multi-entity hierarchy.

Note: Only alphanumeric characters (letters A–Z and a–z, and digits 0–9), space, period, and hyphen are allowed to be used in entity names.

parentId
required
string

The Id of the entity under which you want to create an entity. You can get the parent entity Id by using the GET Entities call.

timezone
required
string

The time zone that is used in this entity.

Responses
200
post/v1/entities
Request samples
application/json
{
  • "displayName": "Acme-Asia",
  • "locale": "zh_CN",
  • "name": "Acme-Asia",
  • "parentId": "8a808255557baba1015580e12fa5083a",
  • "timezone": "Asia/Harbin"
}
Response samples
application/json
{
  • "id": "8a80825556ff28a4015709096c5d6f5d",
  • "name": "Acme-Asia",
  • "displayName": "Acme-Asia",
  • "locale": "zh_CN",
  • "timezone": "Asia/Harbin",
  • "status": "Unprovisioned",
  • "parentId": "8a808255557baba1015580e12fa5083a",
  • "tenantId": "6398",
  • "success": true
}