GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Create an Entity

post
https://na1.ironcladapp.com/public/api/v1/entities

Create a new entity. More details on creating an entity can be found in the Entity Overview article.

OAuth Scope required: public.entities.createEntities

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

The name of the Entity.

relationshipTypeKey
array of strings

The key of the relationship type to be added to the entity. The key must match a valid relationship type in the company settings. The key is displayed on the relationship types page in Data Manager and is always a single word without spaces that starts with a lowercase. For now, only one relationship type can be added or updated per entity. More info on relationship types can be found in the Entity Relationship Types article.

relationshipTypeKey
string
enum
Defaults to ACTIVE

The status of the entity

Allowed:
properties
object

A key:value map of properties to add. The two below are examples. More details on the properties can be found in the Entity Properties article.

parent
object

Object containing Record IDs or Ironclad IDs to be set as the parent of the current record.

Headers
string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Updated 11 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago