How to delete a list item

• 1 minute to read

To delete a list, use the Lists endpoint. These examples use the Category list for demonstration purposes.

Warning

Do not delete built-in lists.

DELETE https://{{env}}.superoffice.com/{{tenant}}/api/v1/List/108 HTTP/1.1
Authorization: Bearer {{token}}

For user-defined lists, use the list Id in the ListEntityId query string parameter.

POST https://{{env}}.superoffice.com/{{tenant}}/api/v1/Agents/List/DeleteListEntity?ListEntityId=108 HTTP/1.1
Authorization: Bearer {{token}}

Response:

HTTP Status 204

How to delete a list entity using the SuperOffice.WebApi proxy client.

For user-defined lists, use the list Id

var config = new WebApiOptions(tenant.WebApiUrl);
config.Authorization = new AuthorizationAccessToken("8A:Cust12345.Example-Token", OnlineEnvironment.SOD);

var listAgent = new ListAgent(config);
await listAgent.DeleteListEntityAsync(108);

Back