API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Update profile (PATCH)

The PATCH method applies partial modifications to a single profile specified by the profileId parameter. The profile will only be updated with the information specified in the path and the values included in the request body.

The HTTP PATCH request method applies partial modifications to a resource. Click here to learn about 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.

Note: Please consider the following when using PATCH:

  • When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.
  • When sending a PATCH request with both replace and remove operations, please ensure that replace comes before remove in the operation array. This order helps avoid unintended remove errors on fields that are about to be updated.

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.

profileIdinteger Required

System generated unique identifier of the profile.

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
valuestring

Value to be added or replaced.

Response

200
Object

Response Attributes

CustomFieldsarray

A collection of Custom Fields associated with the profile.

Show child attributes

ProfileIdinteger

Read-Only Id associated with the Profile.

IsActiveboolean

Defines whether the item is Active or Inactive.

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

RegistrationConfirmedboolean

An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.

CustomerTypestring

An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.

PreserveConsentsboolean

Specifies whether to retain the contact element consents or deactivate them. To retain the contact element consents, set the value as True. If set to False, the contact element consents will be deactivated. This setting defaults to True, if not specified.

PreservePreferencesboolean

Specifies whether to retain the preferences or deactivate them. To retain the preferences, set the value as True. If set to False, the preferences will be deactivated. This setting defaults to True, if not specified.

CustomerNameobject

Name fields associated with the profile.

DefaultLocalestring

Default Locale for the profile.

UpdateStatusstring

Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.

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. See error description for more details.
409
Object
The request could not be completed due to a conflict with the current state of the target resource. In most cases, an instance with the same already exists on the target resource. You must update the request before trying again.
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?