Update a filter option

PATCH

https://v1.api.partnerpage.io/api/directory/private/v1alpha/filters/:filterId/options/:optionId/

Update a custom filter option. To replace the image, send base64 in image or the URL returned by POST /api/core/private/v1alpha/files/ in imageUrl; the file is copied into the option. Sending the option’s current image URL back in imageUrl changes nothing; any other URL is refused. A file in image wins over imageUrl, and a value in either wins over null in the other. null alone removes the image, and leaving both out keeps it

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

filterIdstringRequiredformat: "uuid"

ID of the filter

optionIdstringRequiredformat: "uuid"

ID of the filter option to update

Request

This endpoint expects an object.

namestringOptional<=150 characters

orderintegerOptional>=0

imagestring or nullOptionalformat: "binary"

imageUrlstring or nullOptionalformat: "uri">=1 character

Response

Details of the filter option

hrefstringRead-only

idstringformat: "uuid"

namestring

orderinteger>=0

slugstring

imagestring or null

imageUrlstring or null

filterstringformat: "uuid"

parentOptionIdstringformat: "uuid"

parentOptionSlugstring

hasResultsboolean or nullOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error