Creates a new entity, sending entity data in the request body. Two objects are required: general_data and EITHER user_data OR business_data but the objects can be empty.

The user_data is required if general_data.entity_type is set to user, otherwise this field will be ignored.

The business_data is required if general_data.entity_type is set to business, otherwise this field will be ignored.

If the /entities/create API is called for an entity that already exists in our system (i.e. has an existing entity_id, it is treated it as an upsert and an update on the existing entity is performed. The response to the request will then contain the entry previously_existed: true.

Note that Unit21 selectively ignores upserts if the request is identical to a previous request. The response to any isgnored upsert will contain the field ignored: true.

The response will consist of the following fields:

FieldTypeDescription
entity_idStringUnique identifier of the entity on your platform
unit21_idStringInternal ID of the entity within Unit21's system
previously_existedBooleanIf entity (with the same entity_id) already exists

Updates to an entity's general_data.entity_id are not allowed.

You can batch upload entities to entities/create.

Language
Authentication
Header
URL
Click Try It! to start a request and see the response here!