EntityField Resource

Add columns to a custom or standard entity. Every custom field receives a __c suffix automatically — send the plain name in the payload.

See the Entity Management API Overview for auth, permissions, and response shape, and Field Type Reference for the per-type required properties.

Create a Field

POST /api/3.0/entity/EntityField
Authorization: Bearer <token>
Content-Type: application/json
Accept: application/json

{
  "EntityId": "7NS0000000000A50001",
  "Name": "ContractNumber",
  "Label": "Contract Number",
  "FieldTypeId": "7NY0000000000000000",
  "Length": 100
}

The response returns the new field ID:

{ "id": "7NX0000000000CB0001", "errors": [], "success": true }

Payload Reference

Reserved Field Names

These names are rejected on create — they are already provisioned by the platform:

Id, Name, OwnerId, IsDeleted, CreatedOn, ModifiedOn, CreatedById, ModifiedById, RecordTypeId

The comparison is case-insensitive against the base name (before the __c suffix). Additionally, a field's Name cannot equal its parent entity's Name, cannot contain spaces, and cannot be purely numeric.

FieldOptions

Advanced per-field options live inside a nested FieldOptions object. Send only options that apply to the field type — unrelated options are rejected.

{
  "EntityId": "7NS0000000000A50001",
  "Name": "Notes",
  "Label": "Notes",
  "FieldTypeId": "7NY0000000000040000",
  "Length": 32000,
  "NumberOfVisibleLines": 5,
  "FieldOptions": { "IsHtmlField": true }
}

Get a Field

GET /api/3.0/entity/EntityField/<field id>
Authorization: Bearer <token>
Accept: application/json

List Fields on an Entity

GET /api/3.0/entity/EntityField?entityid=<entity id>&limit=200
Authorization: Bearer <token>
Accept: application/json

Supports the same filters, sorting, and pagination as the record-CRUD API (see Read records).

Update a Field

PATCH /api/3.0/entity/EntityField/<field id>
Authorization: Bearer <token>
Content-Type: application/json
Accept: application/json

{
  "Label": "Contract # (Updated)",
  "HelpText": "External contract number from the CRM."
}

Editable after creation

• Label, Description, HelpText, DefaultValue, IsRequired, Searchable, IsAudited.
• Length — can be increased on Text fields. Cannot be increased above 4,000 if the field is referenced by any formula.
• PicklistSortAlphabetically, NumberOfVisibleLines.
• LookupFilter — the full filter is replaced on PATCH (send the complete criteria array).
• FieldOptions.* — partial merge; only the keys you send are updated, the rest are preserved.

Immutable after creation

• FieldTypeId — the field type cannot be changed. Delete and recreate if a type change is needed.
• Name — the API name is set at creation and does not change.
• RelatedToEntityId and RelatedToFieldId when the field is already referenced by another field (formula, rollup, etc.).
• On "critical" entities (User, Account, Contact, and other platform-managed types), even data-type-compatible property changes may be rejected.

Delete a Field

DELETE /api/3.0/entity/EntityField/<field id>
Authorization: Bearer <token>

Deletion drops the underlying database column and all its data. It is blocked, not cascaded, in these cases:

• The field is referenced by a RecordType.
• The field is referenced by a field on another entity (Lookup target, cross-entity formula).
• The field is referenced by a formula on the same entity.

Remove the dependent references first, then retry the delete.

Status Codes

<< Entity Resource | Field Type Reference >>