PATCH {clientId}/Picklist/{Id}

This method allows you to update a single Picklist specified by the Id parameter.

Request Information

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.

URI Parameters

Name	Description	Type	Additional information
clientId	This is your organization’s MyPreferences Account Id.	string	Required
Id	Id of the Picklist to update	integer	Required

Body Parameters

Name	Description	Type	Additional information
Operations	A collection of PATCH operations that you want to perform on the object.	Collection of OperationOfPicklist

Request Formats

application/json, text/json, application/json-patch+json

Sample:

[
  {
    "path": "sample string 2",
    "op": "sample string 3"
  },
  {
    "path": "sample string 2",
    "op": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<JsonPatchDocumentOfPicklist5B0F46o8 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNetCore.JsonPatch">
  <ContractResolver i:nil="true" />
</JsonPatchDocumentOfPicklist5B0F46o8>

Response Information

Response Codes

HTTP Status Code	Text	Description
200	OK	The request was successfully processed.
400	Bad Request	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	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403	Forbidden	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.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

Picklist

Name	Description	Type	Additional information
Id	A read-only field that uniquely identifies the picklist	integer	Read-Only
Edited		EditInfo	Read-Only
Name	Name of the picklist	string	Required Max length: 100 Min length: 1
Description	Description of the picklist	string	Max length: 256
IsActive	Status of the field select option 1(Active) or 0(Inactive)	boolean
FieldSelectOptions	Field select options defined for the picklist	Collection of FieldSelectOption	Required

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "Id": 1,
  "Edited": {
    "CreateDate": "sample string 1",
    "CreatedBy": "sample string 2",
    "ModifiedDate": "sample string 3",
    "ModifiedBy": "sample string 4"
  },
  "Name": "sample string 2",
  "Description": "sample string 3",
  "IsActive": true,
  "FieldSelectOptions": [
    {
      "LocalizedFieldSelectOptions": [
        {
          "Locale": "sample string 1",
          "DisplayText": "sample string 2"
        },
        {
          "Locale": "sample string 1",
          "DisplayText": "sample string 2"
        }
      ],
      "Value": "sample string 1",
      "DisplayOrder": 2,
      "IsDefault": true,
      "IsActive": true
    },
    {
      "LocalizedFieldSelectOptions": [
        {
          "Locale": "sample string 1",
          "DisplayText": "sample string 2"
        },
        {
          "Locale": "sample string 1",
          "DisplayText": "sample string 2"
        }
      ],
      "Value": "sample string 1",
      "DisplayOrder": 2,
      "IsDefault": true,
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample:

<Picklist xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <Description>sample string 3</Description>
  <FieldSelectOptions>
    <FieldSelectOption>
      <DisplayOrder>2</DisplayOrder>
      <IsActive>true</IsActive>
      <IsDefault>true</IsDefault>
      <LocalizedFieldSelectOptions>
        <LocalizedFieldSelectOption>
          <DisplayText>sample string 2</DisplayText>
          <Locale>sample string 1</Locale>
        </LocalizedFieldSelectOption>
        <LocalizedFieldSelectOption>
          <DisplayText>sample string 2</DisplayText>
          <Locale>sample string 1</Locale>
        </LocalizedFieldSelectOption>
      </LocalizedFieldSelectOptions>
      <Value>sample string 1</Value>
    </FieldSelectOption>
    <FieldSelectOption>
      <DisplayOrder>2</DisplayOrder>
      <IsActive>true</IsActive>
      <IsDefault>true</IsDefault>
      <LocalizedFieldSelectOptions>
        <LocalizedFieldSelectOption>
          <DisplayText>sample string 2</DisplayText>
          <Locale>sample string 1</Locale>
        </LocalizedFieldSelectOption>
        <LocalizedFieldSelectOption>
          <DisplayText>sample string 2</DisplayText>
          <Locale>sample string 1</Locale>
        </LocalizedFieldSelectOption>
      </LocalizedFieldSelectOptions>
      <Value>sample string 1</Value>
    </FieldSelectOption>
  </FieldSelectOptions>
  <IsActive>true</IsActive>
  <Name>sample string 2</Name>
  <Edited>
    <CreateDate>sample string 1</CreateDate>
    <CreatedBy>sample string 2</CreatedBy>
    <ModifiedBy>sample string 4</ModifiedBy>
    <ModifiedDate>sample string 3</ModifiedDate>
  </Edited>
  <Id>1</Id>
</Picklist>