API ReferenceManage entities

Create multiple entities in bulk

This method creates multiple entities within a specified entity collection in a single request. Each entity must be associated with at least one asset. This endpoint is useful for efficiently adding multiple entities, such as a roster of players or a group of characters.

Path parameters

entity_collection_idstringRequired
The unique identifier of the entity collection in which to create the entities.

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
entitieslist of objectsRequired

Response

The entities have been successfully created.
success_countinteger or null
The number of entities that were successfully created.
failed_countinteger or null
The number of entities that failed to be created due to errors, such as missing assets.
entitieslist of objects or null
An array of objects representing the entities that were successfully created. Each object includes the unique identifier, name, and current status.
errorslist of objects or null
An array of error objects for entities that failed to be created. Each error object provides details about the failure, including the index of the entity in the original request, the entity's name, and the reason for the failure.

Errors