Archive or unarchive a select option

post

https://api.perk.com/custom-fields/{custom_field_id}/select-options/{option_id}/{archive_action}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Archives or unarchives a single-select option on a custom field. This endpoint is idempotent: archiving an already-archived option (or unarchiving an already-active option) succeeds without making any changes and returns the option's current state.

Unarchiving is rejected if another active option for the same field already has the same value. Letter casing is ignored when comparing options.

Responses

401

Returns '401 Unauthorized' when the Authorization header is missing or the API key is invalid. This response has no body.

200Returns 200 OK and the option's resulting state.

400Returns '400 Bad Request' when custom_field_id or option_id is missing or not a valid ID, or archive_action is not 'archive' or 'unarchive'.

404Returns '404 Not Found' when custom_field_id doesn't exist or doesn't belong to the account associated with your API key, or when option_id doesn't exist on that custom field.

409Returns '409 Conflict' when unarchiving an option whose value (case-insensitive) matches an already-active option on the same custom field.