FIfieldpulse
Custom Fields

Create a custom field

Changed on
post/custom-fields

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
  • Auth
    API key in header x-api-key

Request body

namestring required

Unique for the user company.

positionnumber required
permissionstring required

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

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

The type of custom field.

can_customer_viewboolean
field_widget_idinteger required

Existing custom field widget id.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the success response with the status