Skip to main content
POST
Update a Company Field

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Path Parameters

fieldId
string
required

Field ID

Example:

"field-1234"

Body

application/json

The properties that can be updated on a Field. Only provided properties are updated.

name
string

The field's new name. Must be unique among the fields of the same entity type that are available in the same context.

Required string length: 1 - 255
Example:

"Sourced By"

description
string | null

A description of the field's purpose. Pass null to clear an existing description.

Maximum string length: 255
Example:

"Where this company is headquartered"

isRequired
boolean

Whether a value for this field is required when creating an entity or List Entry.

Example:

true

Response

No Content