Contacts

Update contact field

Update a custom contact field. type and key can both be changed. Changing the type preserves existing values in place (they go dormant in their original column and return if the type is reverted); same-storage types reuse the value directly. System fields stay immutable.

patch/orgs/contacts/fields/{field_id}

Request

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

Path parameters

field_idstring required

Field ID

Request body

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

Accent color, by name

uniqueboolean
readonlyboolean

Whether the field is readonly.

archivedboolean

Whether the field is archived.

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.

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.