ackDB

Create a custom attribute definition

Strict create — never an upsert; 409 if the key already exists (as an attribute OR a trait), collides with a reserved field for the scope, or starts with a registered source's <source>_ prefix.

post/api/v1/ackdb/attributes

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Request body

keystring required

snake_case, ^[a-z][a-z0-9_]{0,63}$.

labelstring

Display label; defaults to a prettified key.

scope'company' | 'contact' | 'person' required

What the fact is ABOUT. Prefer person for facts about a HUMAN (is_champion, do_not_contact) — they survive job changes and render on the People view. contact scopes the fact to ONE employment and is API-only: no console grain renders it.

type'string' | 'number' | 'boolean' | 'date' | 'string_array' required
descriptionstring nullable

Read by the AI agent for semantic understanding.

allowedValuesstring[] nullable

Enum constraint — string type only, non-empty if present.

Response

The created attribute definition.

dataunknown required

Changes

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