API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Update customer type

This method allows you to update a single customer type by providing the corresponding TypeId 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.

Note: 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

Indicates the data format of the request body.

Path Parameters

clientIdstring Required

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

typeIdinteger Required

Id of the CustomerType 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

TypeNamestring Required

The name given to the type.

LocalizedFieldsarray Required

A collection of a locale specific name/value pair of Strings used to support localization.

Show child attributes

IsDefaultboolean

Determines if it is the Default Type.

IsActiveboolean

Defines whether the item is Active or Inactive.

TypeIdinteger

A read-only field that uniquely identifies the Type.

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

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?