Update text custom field
This method allows you to update a single custom field of type Text by providing the corresponding Id parameter.
The HTTP PATCH request method applies partial modifications to a resource. Click here to learn about using PATCH.
The MyPreferences API supports add, replace, remove, and test PATCH operations. The API does not support move and copy PATCH operations.In the JSON body of your request, send the op, path, and value parameters:
- op denotes the type of operation to execute such as add, replace, remove, or test.
- path denotes the path of the target location on the resource to update.
- value denotes the value to apply.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences Account Id. A 404 is returned if this value is invalid.
Id of the Custom field to update.
Body Parameters
Operation to be performed on the target object. Valid values are: add/remove/replace/test.
JSON pointer that references a location within the target document where the operation is performed.
JSON pointer to the location to copy or move.
Value to be added or replaced.
Response
Response Attributes
Id of the field (Read-Only).
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
Minimum length supported by the field.
Maximum length supported by the field.
The default value of the field.
An optional regular expression that can be used to validate a field on update.
Stores the field's input mask definition. It will be used to drive data collection on a UI.
The name of the field.
Localized display names of the field.
Show child attributes
The description of the field.
Id associated with the update rule. 1: The value can be added, changed, or cleared without restriction. 2: Once a value is added, the field becomes uneditable. It cannot be changed or cleared. 4: Once a value is added, it can be edited, but cannot be cleared. 5: Once added to a profile, the field immediately becomes uneditable. It cannot be changed or cleared.
Determines the display order of the field on customer-facing user interfaces.Determines the display order of the field when driving preference collection touchpoints.
Determines whether the custom field is required when creating or replacing a profile. When set to TRUE, the field cannot be removed from the profile.
Allows custom fields to exist with a blank value on a profile. When set to FALSE, the custom field must be accompanied by a non-blank value when adding or updating a profile. This property works together with UpdateRules.
Indicates the status of the field.
What made this section unhelpful for you?
Response
What made this section unhelpful for you?