FIfieldpulse
Custom Fields

Update custom field by ID

Changed on
put/custom-fields/{customfieldId}

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields/{customfieldId}
  • Auth
    API key in header x-api-key

Path parameters

customfieldIdstring required

Request body

namestring required
positionnumber
permissionstring

Comma-separated string of user rules, for example 1,2,3.

is_activeboolean
object'customer' | 'job' | 'project' | 'invoice' | 'asset' | 'job_visit' | 'maintenance_agreement' | 'order'

The type of custom field.

can_customer_viewboolean
field_widget_idinteger

Existing custom field widget id.

Response

Successful response

errorboolean

false when the request succeeds.

responseobject

The updated record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property