Create entity record

Create an entity record in an Entity.

Endpoint

POST /api/v1/external/projects/{projectUuid}/entities/{entityId}/records

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication
Accept	string	No	Must be application/json

Request Body

The request should be sent as application/json with the following fields:

Field	Type	Required	Description
records	array	Yes	Array of entity record objects
records.*.data	object	Yes	The entity record data

Parameters

Parameter	Type	Required	Description
projectUuid	string	Yes	The UUID of the project to upload the document to. Can be found in the Recognito application.
entityId	string	Yes	The ID of the entity to create the record in. Can be found in the Recognito application.

Response

Success Response (200 OK)

{
  "status": "done",
  "entityRecordsInserted": 5
}

Error Response (400 Bad Request)

{
  "error": "string",
  "message": "string"
}

Example

Request

curl -X POST https://apiv2.recognito.io/api/v1/external/projects/{projectUuid}/entities/{entityId}/records \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "records": [
      {
        "data": {
          "name": "John Doe",
          "email": "john.doe@example.com"
        }
      }
    ]
  }'

Response

{
  "status": "done",
  "entityRecordsInserted": 1
}