Retrieve information subscription deletion

GET

/deletions/{id}

const url = 'https://example.com/deletions/25';
const options = {method: 'GET', 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 GET \
  --url https://example.com/deletions/25 \
  --header 'Authorization: Bearer <token>'

Retrieve information about a deletion by querying the ID sent in a deletion request

Authorizations

podcast_auth
read:subscriptions

Parameters

Path Parameters

required

number format: integer

Example

Responses

200

The object was successfully deleted

object

deletion_id

required

number format: integer

status

required

string

Allowed values: SUCCESS FAILURE PENDING

message

string

Examples

{
  "deletion_id": 25,
  "status": "SUCCESS",
  "message": "Subscription deleted successfully"
}

{
  "deletion_id": 25,
  "status": "PENDING",
  "message": "Deletion is pending"
}

{
  "deletion_id": 25,
  "status": "FAILURE",
  "message": "The deletion process encountered an error and was rolled backwas rolled back"
}

object

deletion_id

required

number format: integer

status

required

string

Allowed values: SUCCESS FAILURE PENDING

message

string

Examples

{
  "deletion_id": 25,
  "status": "SUCCESS",
  "message": "Subscription deleted successfully"
}

{
  "deletion_id": 25,
  "status": "PENDING",
  "message": "Deletion is pending"
}

{
  "deletion_id": 25,
  "status": "FAILURE",
  "message": "The deletion process encountered an error and was rolled back"
}

401

Unauthorized

object

code

required

string

message

required

string

Example

{
  "code": 401,
  "message": "User not authorized"
}

object

code

required

string

message

required

string

Example

{
  "code": 401,
  "message": "User not authorized"
}

404

Not found

object

code

required

string

message

required

string

Example

{
  "code": 404,
  "message": "Resource not found"
}

object

code

required

string

message

required

string

Example

{
  "code": 404,
  "message": "Resource not found"
}

405

Validation exception

object

code

required

string

message

required

string

Example

{
  "code": 405,
  "message": "Input could not be validated"
}

object

code

required

string

message

required

string

Example

{
  "code": 405,
  "message": "Input could not be validated"
}