API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Update datetime custom field

This method allows you to update a single custom field of type DateTime 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.

When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences Account Id. A 404 is returned if this value is invalid.

Idstring Required

Id of the Custom field to update.

Body Parameters

opstring

Operation to be performed on the target object. Valid values are: add/remove/replace/test.

pathstring

JSON pointer that references a location within the target document where the operation is performed.

fromstring

JSON pointer to the location to copy or move.

valueobject

Value to be added or replaced.

Response

200
Object

Response Attributes

MinDatestring

Minimum date supported by the field.

Max length
50
MaxDatestring

Maximum value supported by the field.

Max length
50
DefaultValuestring

The default value of the field.

Max length
50
Idinteger

Id of the field (Read-Only).

Editedobject

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

Namestring Required

The name of the field.

Min length
1
Max length
94
LocalizedDisplayNamesarray Required

Localized display names of the field.

Show child attributes

Descriptionstring

The description of the field.

Max length
256
UpdateRuleIdinteger

Id associated with the update rule.

Enum values:
DisplayOrderinteger

Determines the display order of the field on customer-facing user interfaces.

IsRequiredboolean

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.

Default value
false
AllowBlanksboolean

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.

Default value
true
IsExtensionboolean

Determines whether the custom field is flagged as an extension field or not.

IsActiveboolean

Indicates the status of the field.

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

PATCH

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?