pixi Developer & Integration Documentation

pixiPicklistDelete

Description

API call deletes a specified picklist


Request Parameters

# Name Type Required Example Description
1 PicklistNumber integer 1 123 Picklist number
2 ForceDelete boolean 0 1 Force the deletion of picklist even if it is currently in use

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiPicklistDelete>
         <dem:PicklistNumber>123</dem:PicklistNumber>
         <dem:ForceDelete>1</dem:ForceDelete>
      </dem:pixiPicklistDelete>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Status output

# Name Type Description
1 Status string Execution status (SUCCESS/ERROR)
2 Message string Description of the status

Additional Notes

If the picklist is currently in use the API call will not allow the deletion of the picklist.

The deletion of the picklist is still possible with the use of "ForceDelete" parameter, but this might lead to unpredictable behavior.