Denylist

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

Field nameValue typeNon-nullDescription
projectId
ID
true
A globally-unique identifier.
type
DenylistType
true
hash
NonEmptyString
true
MD5
phoneNumber
PhoneNumber
false
emailAddress
EmailAddress
false
expiresAt
DateTime
false
createdAt
DateTime
true
The date and time when a item was created.
updatedAt
DateTime
true
The date and time when a item was updated.

Queries

denylist

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

denylist arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
type
DenylistType
false
limit
NonNegativeInt
false
cursor
ID
false
🔑
Minimal role required: MANAGER

Mutations

denylistAddPhoneNumber

Creates a blacklist item.

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

denylistAddPhoneNumber arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
phoneNumber
PhoneNumber
true
expiresAt
DateTime
false
🔑
Minimal role required: MANAGER

denylistAddEmailAddress

Creates a denylist item.

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

denylistAddEmailAddress arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
emailAddress
EmailAddress
true
expiresAt
DateTime
false
🔑
Minimal role required: MANAGER

denylistItemDelete

Deletes a email or phone number.

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

denylistItemDelete arguments

Field nameValue typeRequiredDescription
projectId
ID
true
A globally-unique identifier.
hash
String
true
MD5
🔑
Minimal role required: MANAGER