API Reference

Update a custom field

put
https://api.heymantle.com/v1/customers/custom_fields/

Updates a custom field by ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the custom field

Body Params
string

The ID of the app to associate with the custom field

The default value of the custom field

The default string value of the custom field for type "string"

options
array of strings
options
boolean

If true, and no appId is set, the field will be settable on all apps. If false and no appId is set, it will be a customer level field.

boolean

If true, the field will be shown on the customer detail page by default. Can be toggled by the user.

boolean
Defaults to true

If true, your field will only be accessible via the API by your client. If false, all clients can access the field but only your client can mutate it.

boolean
Defaults to true

If true, the custom field can be used as a filter in the customer list and customer segments.

Responses

404

Custom field not found

Updated 28 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago