entity-types

Create Entity Type

Create a new entity type.

post/api/v1/entity-types

Request

  • Base URL: https://api.gnosari.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gnosari.com/api/v1/entity-types
  • Auth: one of:
    • HTTP bearer
    • API key in header X-AUTH-TOKEN

Request body

namestring required

Entity type name (e.g., 'Job Candidate', 'Sales Lead')

descriptionstring nullable

Description of what this entity type represents

iconstring nullable

Heroicon name for UI display

primary_display_fieldsstring[] nullable

Fields to show in list views

identity_fieldstring nullable

Name of the attribute to use as the person's identity/display field. Must name one of this type's attributes. Any attribute type may be designated. Unset → server heuristic.

Response

Successful Response

namestring required

Entity type name (e.g., 'Job Candidate', 'Sales Lead')

descriptionstring nullable

Description of what this entity type represents

iconstring nullable

Heroicon name for UI display

primary_display_fieldsstring[] nullable

Fields to show in list views

identity_fieldstring nullable

Name of the attribute to use as the person's identity/display field. Must name one of this type's attributes. Any attribute type may be designated. Unset → server heuristic.

idinteger required
account_idinteger nullable
is_templateboolean
template_categorystring nullable
created_atstring date-time required
updated_atstring date-time nullable
agent_countinteger
entity_countinteger

Changes

No recorded changes to this operation across all 1 revision of this API.