API Reference

Denylist overview

List of blocked phone numbers and emails.

Object types

DenylistItem

type DenylistItem {
  projectId: ID!
  type: DenylistType!
  hash: NonEmptyString!
  phoneNumber: PhoneNumber
  emailAddress: EmailAddress
  expiresAt: DateTime
  createdAt: DateTime!
  updatedAt: DateTime!
}

DenylistItem fields

Queries

denylist

denylist(
	projectId: ID!
	type: DenylistType
	limit: NonNegativeInt
	cursor: ID
): [DenylistItem]

denylist arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

Mutations

denylistAddPhoneNumber

Creates a blacklist item.

denylistAddPhoneNumber(
	projectId: ID!
	phoneNumber: PhoneNumber!
	expiresAt: DateTime
): DenylistItem

denylistAddPhoneNumber arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

denylistAddEmailAddress

Creates a denylist item.

denylistAddEmailAddress(
	projectId: ID!
	emailAddress: EmailAddress!
	expiresAt: DateTime
): DenylistItem

denylistAddEmailAddress arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

denylistItemDelete

Deletes a email or phone number.

denylistItemDelete(
	projectId: ID!
	hash: String!
): String

denylistItemDelete arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>