v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Entities

validateEntity

Validates an entity against the schema.

post/v1/entity/{slug}:validate

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

Request body

_idstring uuid

_orgstring

Organization Id the entity belongs to

_schemastring

URL-friendly identifier for the entity schema

_titlestring nullable

Title of entity

_tagsstring[] nullable

_created_atstring date-time nullable

_updated_atstring date-time nullable

_deleted_atstring date-time nullable

_purposestring[] nullable

_purpose_namestring[] nullable

Automatically computed purpose names from _purpose attribute

_manifeststring[] nullable

Manifest ID used to create/update the entity

_changesetsobject nullable

Pending attribute changesets for attributes configured with external or approval edit mode.

The value shape is Changeset (proposed_value, created_at, edit_mode, ...) and is what :apply / :dismiss operate on.

Read-only via normal entity PATCH/PUT operations — those handlers strip _changesets from request bodies. Use the changeset management endpoints to mutate this field.

Example request

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": [
    "example",
    "mock"
  ],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": [
      "org:456",
      "org:789"
    ],
    "edit": [
      "org:456"
    ],
    "delete": [
      "org:456"
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Success

status'success' required

Example response

{
  "errors": [
    {
      "code": "custom",
      "params": {
        "type": "missing_field"
      },
      "path": [
        "first_name"
      ],
      "message": "Invalid input"
    }
  ]
}