Видалення номерів із підписки

Видалення номера відправлення з підписки після досягнення фінального статусу не є обов’язковим. Рекомендується періодично видаляти завершені відправлення, щоб підтримувати список номерів у підписці актуальним.

Видалити номери з існуючої підписки

delete

/tracking-push/subscribers/{id}/numbers

Цей метод дозволяє видаляти номери відправлень з існуючої підписки, зазначеної за її унікальним ідентифікатором.

Метод повертає код 200 у будь-якому разі, зокрема й тоді, коли не видалено жодного номера. Результат операції визначається параметром status у тілі відповіді, а не HTTP-кодом.

Authorizations

AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters

idstringRequired

Унікальний ідентифікатор підписки, з якої будуть видалені номери відправлень. Це обов’язковий параметр шляху.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26

Body

numbersstring[]Optional

Список номерів відправлень, які необхідно видалити з підписки.

Example: ["20600000179995","20600000179992"]

Responses

200

Номери успішно видалено з підписки.

application/json

statusstring · enumOptional

Результат операції:

• success — видалено всі номери;
• partial_success — видалено частину номерів;
• error — не видалено жодного номера.

Possible values:

401

Unauthorized

application/json

404

The specified resource was not found

application/json

422

Validation error

application/json

503

Connection time-out

application/json

delete/tracking-push/subscribers/{id}/numbers

DELETE /v.1.0/tracking-push/subscribers/{id}/numbers HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "numbers": [
    "20600000179995",
    "20600000179992"
  ]
}

{
  "status": "success",
  "successful": {
    "message": "Numbers has been deleted successful",
    "deletedNumbers": [
      "SHPL8642391238"
    ],
    "deleted_numbers": [
      "SHPL8642391238"
    ],
    "deletedCount": 1,
    "deleted_count": 1
  }
}

Застарілі параметри

Частина параметрів дублюється у snake_case-написанні. Ці параметри збережено виключно для забезпечення зворотної сумісності — для нових інтеграцій використовуйте варіанти в camelCase.

Застарілий параметр	Використовуйте замість нього
deleted_numbers	deletedNumbers
deleted_count	deletedCount
not_found_numbers	notFoundNumbers
error_count	errorCount

Ці ж застарілі параметри присутні у відповідях на створення та оновлення підписки. Далі в статті вони не повторюються.