---
title: entities.unsubscribedPhone
description: Read unsubscribed phone records with the unsubscribedPhone repository, and change them with the unsubscribed phone mutations. Same records as the REST UnsubscribedPhones entity.
canonical: https://developers.coevera.com/reference/graphql/unsubscribed-phone/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.unsubscribedPhone

Read unsubscribed phone records with the unsubscribedPhone repository, and change them with the unsubscribed phone mutations. Same records as the REST UnsubscribedPhones entity.

REST: [UnsubscribedPhones](https://developers.coevera.com/reference/rest/unsubscribed-phones.md).

## Queries

- `getById(entityId: ID!): UnsubscribedPhoneEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [UnsubscribedPhoneEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: UnsubscribedPhoneFilterInput, orderBy: [UnsubscribedPhoneOrderByInput!], includeDeleted: Boolean): [UnsubscribedPhoneEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: UnsubscribedPhoneFilterInput, orderBy: [UnsubscribedPhoneOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): UnsubscribedPhoneEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

## Mutations

- `createUnsubscribedPhone(input: CreateUnsubscribedPhoneInput!, validationLevel: [ValidationLevel!]): CreateUnsubscribedPhonePayload` Create one record.
- `updateUnsubscribedPhone(input: UpdateUnsubscribedPhoneInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateUnsubscribedPhonePayload` Update fields.
- `bulkUpdateUnsubscribedPhone(input: [CreateOrUpdateUnsubscribedPhoneInput!]!, deleteInput: [DeleteUnsubscribedPhoneInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateUnsubscribedPhonePayload` Create or update many; per-item results.
- `deleteUnsubscribedPhone(input: DeleteUnsubscribedPhoneInput!): DeleteUnsubscribedPhonePayload` Soft-delete.

## Types

### UnsubscribedPhoneEntity (object)

Phone number that opted out of receiving text messages.

- `isDeleteProtected: Boolean!` True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `phone: String` Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
- `revision: Int` Revision when entity was lastly changed.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### UnsubscribedPhoneEntityConnection (object)

Paginated list of UnsubscribedPhone records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [UnsubscribedPhoneEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### UnsubscribedPhoneEntityEdge (object)

A Relay edge containing a `UnsubscribedPhoneEntity` and its cursor.

- `node: UnsubscribedPhoneEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### UnsubscribedPhoneFilterInput (input)

Filter conditions for UnsubscribedPhone records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

- `OR: [UnsubscribedPhoneFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [UnsubscribedPhoneFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: UnsubscribedPhoneFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `phone: EntityFilterStringField` Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.

### UnsubscribedPhoneOrderByInput (input)

Sorting of UnsubscribedPhone records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `phone: OrderByEnum` Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateOrUpdateUnsubscribedPhoneInput (input)

Field values of an UnsubscribedPhone record to create, or to update when its id is set.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `phone: String` Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
- `revision: Int` Revision when entity was lastly changed.

### CreateUnsubscribedPhoneInput (input)

Field values of a new UnsubscribedPhone record.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `phone: String` Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
- `revision: Int` Revision when entity was lastly changed.

### DeleteUnsubscribedPhoneInput (input)

Id of the UnsubscribedPhone record to delete.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.

### UpdateUnsubscribedPhoneInput (input)

Id of an UnsubscribedPhone record and the field values to change.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `phone: String` Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateUnsubscribedPhonePayload (object)

Result of the bulkUpdateUnsubscribedPhone mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateUnsubscribedPhonePayload (object)

Result of the createUnsubscribedPhone mutation.

- `unsubscribedPhone: UnsubscribedPhoneEntity` The created record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### DeleteUnsubscribedPhonePayload (object)

Result of the deleteUnsubscribedPhone mutation.

- `unsubscribedPhone: UnsubscribedPhoneEntity` The deleted record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### UpdateUnsubscribedPhonePayload (object)

Result of the updateUnsubscribedPhone mutation.

- `unsubscribedPhone: UnsubscribedPhoneEntity` The updated record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstUnsubscribedPhones {
  entities {
    unsubscribedPhone {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstUnsubscribedPhones { entities { unsubscribedPhone { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```