KAkantata
Custom Fields

Updating an existing Custom Field

Updates an existing custom field.

Parameters that cannot be updated

Note that the unique_constraint and value_type parameters cannot be updated. They are set during the process of creating a custom field.

Updating choices

This endpoint also allows you to update the list of choices for a custom field with single or multiple choices. For important details regarding how this endpoint affects the list of available choices and how to avoid creating duplicate choices, see the description of the choice body parameter.

This endpoint returns structured Custom Field objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_fields top-level JSON key. Please see our Response Format section for more information.

put/custom_fields/{id}

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Path parameters

idinteger required

The ID of the Model.

Query parameters

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • choices (CustomFieldChoice) - Includes the ID of a Custom Field's choices.
  • creator (User) - Includes the ID of a Custom Field's creator.
  • custom_field_set (CustomFieldSet) - Includes the ID of the Custom Field Set that a field belongs to.
  • external_references (ExternalReference) - Includes references to external integrations for this object.

Request body

Response

Custom Field has been updated.

countinteger
custom_fieldsobject
external_referencesobject
usersobject
custom_field_choicesobject
custom_field_setsobject

Changes

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