/deactivated_phone_numbers

Use this endpoint to return phone numbers deactivated on a specified date.

Secured By: Authentication Token
Description:

When an individual deactivates their phone number that number is then put back into circulation and eventually given to a new owner by the carrier.

This can result in the new owner of the number receiving unwanted text message alerts or phone calls that the previous owner had opted into. To help prevent this, carriers provide regular updates of phone numbers that have recently been deactivated so that those numbers can be removed from any alerts they previously opted into.

TMS provides an easy way to obtain a list of phone numbers reported as deactivated for a given date. This information can then be used to update your internal records and remove deactivated numbers (until the new owner of the number opts into receiving messages). Please note that this endpoint provides all phone numbers reported as deactivated by the carrier for a given date and will include phone numbers you have not sent to prior.

Headers

Name Required Type Description
X-AUTH-TOKEN * string

An authentication token provided to you by GovDelivery.

Query Parameters

Name Required Type Description
date * date

Date for deactivated numbers selection (past dates only). Must be YYYY-MM-DD date format.

Example

/deactivated_phone_numbers?date=2021-11-28

Status

Body

Format: text/csv

Example
15075551212
16125551234
17155559876
12135554561

Body

Format: application/json

Example
{
  "error": "Invalid authentication token"
}