Contacts

Create contact field

Create a new custom contact field. Pass before / after (a sibling field key) to slot it at a global position; omit both to append.

post/orgs/contacts/fields

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/contacts/fields
  • Auth: HTTP bearer

Request body

idstring

Client-generated id for the new field (enables optimistic creation). Encoded (field_…) or raw UUID. Rejected if already in use.

keystring required
color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral'

Accent color, by name

uniqueboolean
readonlyboolean
on_target_delete'restrict' | 'clear' | 'cascade'

What happens when the referenced target is deleted (ref-typed fields only). restrict forbids deleting the target while any cell still points to it. clear allows the delete and drops those field values on remaining rows. cascade also deletes table rows that reference the target via this field.

beforestring
afterstring

Example request

{
  "schema": {
    "visibility": "PRIVATE",
    "default": {
      "file_filename": "document.pdf",
      "file_size": 1024,
      "file_mimetype": "application/pdf"
    }
  }
}

Response

OR

Example response

{
  "schema": {
    "visibility": "PRIVATE",
    "default": {
      "file_filename": "document.pdf",
      "file_size": 1024,
      "file_mimetype": "application/pdf"
    }
  }
}

Changes

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