---
title: "UnsubscribedPhones.update"
method: PATCH
path: "/entities/UnsubscribedPhones/{id}"
tags: ["Unsubscribed"]
---

# UnsubscribedPhones.update

`PATCH /entities/UnsubscribedPhones/{id}`

Modifies UnsubscribedPhone or UnsubscribedPhones with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateUnsubscribedPhoneInput
  - `phone` string — Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
  - `revision` integer — Revision when entity was lastly changed.

## Response `200`

Modification confirmation. Returns resulting UnsubscribedPhone

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` UnsubscribedPhone
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `phone` string — Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
    - `revision` integer — Revision when entity was lastly changed.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)