Delete a catalogue item

DELETE

/api/v1/items/{externalId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://dashboard.azimea.com/api/v1/items/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://dashboard.azimea.com/api/v1/items/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://dashboard.azimea.com/api/v1/items/example \
  --header 'Authorization: Bearer <token>'

Removes one of the items your system sent, by your own id (externalId), so emails stop recommending it. To keep its history instead, send it again with active: false. Items synced from a connected store cannot be deleted here. Needs the items:write permission.

Authorizations

ApiKey

Parameters

Path Parameters

externalId

required

string

Responses

200

Deleted

application/json

object

isSuccess

boolean

value

nullable

status

integer format: int32

errors

Array<object>

object

code

string

message

string

params

object

key

additional properties

fieldErrors

object

key

additional properties

Array<object>

object

code

string

message

string

params

object

key

additional properties

Example

{
  "isSuccess": true,
  "value": null,
  "status": 0,
  "errors": [],
  "fieldErrors": null
}

401

Missing or invalid API key

403

The key lacks the items:write permission