This API is designed to perform an UPDATE operation on API Mapper Set IDs in the indicated Environment. If you would like to update other fields, refer to the Import API Mapper Set.
Notice
Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Locationhttps://api.us1.plainid.iohttps://api.ca1.plainid.iohttps://api.eu1.plainid.ioUsing HTML Encoded Special Characters
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
Important note about headers
Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.
Headers
*Required| Header | Value | cURL Line |
|---|---|---|
| Accept | application/json | -H "Accept:application/json" |
| Content-Type | application/json | -H "Content-Type:application/json" |
cURL Sample Guidelines
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.
For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123
The Environment ID can be found under the Details Tab in the Environment Settings.
API Mapper Set Unique Identifier.
Fields to patch in the API Mapper Set.
[
{
"op": "replace",
"path": "/apiMappersSetId",
"value": "newID"
}
]API Mapper set patch
Successful operation
Validation Error
{
"errors": [
{
"code": "APIV-004",
"args": {
"0": "apiMapperSetId",
"path": "$.apiMappersSetId"
},
"id": "EBS8Z6",
"status": "400",
"name": "apiMappersSetIdUniquenessError",
"message": "Api Mapper Set ID: [apiMapperSetId] must be unique"
}
]
}Response object
Unauthorized
Forbidden
Object not found
Payload Validation Error
{
"errors": [
{
"code": "V-027",
"args": {
"0": "path"
},
"id": "E9YIWG",
"status": "422",
"name": "UnprocessableEntityError",
"message": "$[0].path: is missing but it is required"
}
]
}Response object
Internal Server Error