> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gominerva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add a record

> Adds a record to the working set. It is screenable after the next publish. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.



## OpenAPI

````yaml /api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/records
openapi: 3.0.0
info:
  version: 1.0.0
  title: MinervaAI Admin API
  description: Admin endpoints for the Minerva application suite.
servers:
  - url: https://api.gominerva.com
    description: The production API server for Minerva.
security:
  - ApiKeyAuth: []
tags: []
paths:
  /custom-lists/v2/organizations/{orgId}/{listId}/records:
    post:
      tags:
        - Custom Lists
      summary: Add a record
      description: >-
        Adds a record to the working set. It is screenable after the next
        publish. Requires an admin API key, the **Admin (tenant-wide)** key
        type, which only an owner or admin of this organization can create.
        **Workspace scoped** and **Tenant scoped** keys are refused with 403.
        The `x-user-token` scheme is the Minerva dashboard session token; with
        it, writes require an owner or admin.
      parameters:
        - in: path
          name: orgId
          required: true
          schema:
            type: string
          description: >-
            The organization (tenant) id. Must equal the tenant of the admin
            key.
        - in: path
          name: listId
          required: true
          schema:
            type: string
          description: The custom list id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomListRecordInput'
            examples:
              create:
                summary: '`record_uid` identifies the record within the list.'
                value:
                  record_uid: cl-0001
                  name: Acme Trading Ltd
                  entity_type: organization
                  aliases:
                    - Acme Trading Limited
                  countries:
                    - GB
                  reason: Debanked after relationship review
                  notes: Do not onboard without a compliance sign-off
                  custom_fields:
                    source: manual
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListRecordResponse'
              examples:
                created:
                  summary: The record was staged.
                  value:
                    data:
                      id: 8e7f6a5b-4c5d-4e2f-9a8b-aca9d8e7f6a5
                      tenant_id: 123e4567-e89b-12d3-a456-426614174000
                      list_id: 3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c
                      record_uid: cl-0001
                      status: active
                      entity_type: organization
                      name: Acme Trading Ltd
                      aliases:
                        - Acme Trading Limited
                      countries:
                        - GB
                      reason: Debanked after relationship review
                      notes: Do not onboard without a compliance sign-off
                      custom_fields:
                        source: manual
                      record_hash: ''
                      created_at: '2026-11-05T01:18:55.867Z'
                      updated_at: '2026-11-05T01:18:55.867Z'
        '400':
          description: >-
            Invalid request: a required field is missing or a value is invalid.
            Some validation errors (for example `name is required.`) are plain
            text; others (`error` is `validation_failed`) are a JSON
            `CustomListError`. Branch on `Content-Type`.
          content:
            text/plain:
              schema:
                type: string
                example: name is required.
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                validation:
                  summary: Validation failed.
                  value:
                    error: validation_failed
                    message: 'custom-list: validation failed: name is required'
        '403':
          description: >-
            No credentials were sent; the API key was revoked, has expired, or
            its application is deactivated (`API-key authentication was
            denied.`); the key is not an admin application key (**Workspace
            scoped** and **Tenant scoped** keys are refused); it belongs to
            another organization; or its creator is no longer an owner or admin.
            For a user token, the user is not a member, or is not an owner or
            admin on a write. If the tenant is not entitled to custom lists, the
            body is a JSON `CustomListError` with `error: not_enabled` (`Custom
            lists are not enabled for this tenant.`); every other 403 is plain
            text. Branch on `Content-Type`.
          content:
            text/plain:
              schema:
                type: string
                example: 'Missing Authorization: Api-Key or x-api-key header.'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                not-enabled:
                  summary: Tenant not entitled.
                  value:
                    error: not_enabled
                    message: Custom lists are not enabled for this tenant.
        '404':
          description: >-
            Custom list management is not enabled (`Custom list management is
            not enabled.`); the list, record, upload, job or workspace is not in
            this organization; or the application API key (`mrva-…`) is unknown
            (`API-key authentication was denied.`).
          content:
            text/plain:
              schema:
                type: string
                example: Custom list management is not enabled.
        '409':
          description: >-
            A record with this `record_uid` already exists in the list. JSON
            `CustomListError` with `error: conflict`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                duplicate:
                  summary: '`record_uid` already exists in this list.'
                  value:
                    error: conflict
                    message: 'custom-list: conflict'
        '422':
          description: >-
            A tenant custom-list entitlement limit would be exceeded. JSON
            `CustomListError` with `error: limit_exceeded`, `limit` naming the
            limit (`maxRecordsPerList`) and `max` the configured maximum.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                record-limit:
                  summary: The list is at its record limit.
                  value:
                    error: limit_exceeded
                    limit: maxRecordsPerList
                    max: 25000
        '503':
          description: >-
            The authentication service is temporarily unavailable
            (`Authentication service is unavailable.`). Nothing was changed;
            retry with backoff.
          content:
            text/plain:
              schema:
                type: string
                example: Authentication service is unavailable.
      security:
        - AdminApiKeyAuth: []
        - UserTokenAuth: []
components:
  schemas:
    CustomListRecordInput:
      type: object
      description: >-
        `name` and `entity_type` are always required. Creating also requires
        `record_uid`. An update replaces the record's fields with this body
        rather than merging into them, so a field left out is cleared: send the
        full record every time. `aliases` and `countries` are stored
        pipe-joined.
      properties:
        record_uid:
          type: string
        name:
          type: string
        entity_type:
          type: string
          enum:
            - individual
            - organization
            - unknown
        aliases:
          type: array
          items:
            type: string
        countries:
          type: array
          items:
            type: string
        date_of_birth:
          type: string
        date_of_incorporation:
          type: string
        reason:
          type: string
        notes:
          type: string
        custom_fields:
          type: object
          additionalProperties:
            type: string
    CustomListRecordResponse:
      type: object
      description: '`{ data: CustomListRecord }`'
      properties:
        data:
          $ref: '#/components/schemas/CustomListRecord'
      required:
        - data
    CustomListError:
      type: object
      properties:
        error:
          type: string
          description: >-
            Machine-readable code, e.g. `validation_failed`, `limit_exceeded`,
            `conflict`, `not_enabled`, `upload_capacity_exceeded`,
            `upload_request_timeout`.
        message:
          type: string
        limit:
          type: string
          description: >-
            For `limit_exceeded`: the entitlement limit, e.g.
            `maxRecordsPerList`.
        max:
          type: integer
          description: 'For `limit_exceeded`: the configured maximum.'
        retryable:
          type: boolean
      additionalProperties: true
    CustomListRecord:
      type: object
      properties:
        id:
          type: string
        tenant_id:
          type: string
        list_id:
          type: string
        record_uid:
          type: string
        status:
          type: string
          enum:
            - active
            - archived
        entity_type:
          type: string
          enum:
            - individual
            - organization
            - unknown
        name:
          type: string
        aliases:
          type: array
          items:
            type: string
        countries:
          type: array
          items:
            type: string
        date_of_birth:
          type: string
        date_of_incorporation:
          type: string
        reason:
          type: string
        notes:
          type: string
        custom_fields:
          type: object
          additionalProperties:
            type: string
        record_hash:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - tenant_id
        - list_id
        - record_uid
        - status
        - entity_type
        - name
        - aliases
        - countries
        - custom_fields
        - record_hash
        - created_at
        - updated_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Admin API key for authentication. Manage API keys in the Minerva
        dashboard under Administration > Developers.
    AdminApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        An admin application key: `Authorization: Api-Key <token>` (or legacy
        `x-api-key`). Only tenant owners and admins can create one. Standard
        keys are refused with 403 on workspace management and tenant
        configuration routes.
    UserTokenAuth:
      type: apiKey
      in: header
      name: x-user-token
      description: Firebase user token for authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.