Enums

AddressType

Schema: user, company

The type of an address

enum AddressType {
  ACCOUNTING
  BILLING
  HEADQUARTERS
  HOME
  IT
  LEGAL
  MARKETING
  OPERATIONS
  OTHER
  PRIVATE
  SALES
  SUPPORT
  WORK
}

AdminB2cConnectionType

Schema: user

The type of a B2C and C2B connection

enum AdminB2cConnectionType {
  ADMIN
  EXTERNAL_ADMIN
  OWNER
}

AiTaskRunStatus

Schema: user, company

Where a run has got to

enum AiTaskRunStatus {
  "Answered; `result` holds it"
  COMPLETED
  "Ended without an answer; `error` says why"
  FAILED
  "Published, not yet picked up"
  QUEUED
  "Being answered now"
  RUNNING
}

B2bConnectionType

Schema: company

The type of a B2B connection

enum B2bConnectionType {
  CLIENT
  OTHER
  PARTNER
  VENDOR
}

B2cConnectionType

Schema: user, company

The type of a B2C and C2B connection

enum B2cConnectionType {
  ADMIN
  CUSTOMER
  EMPLOYEE
  EXTERNAL_ADMIN
  OTHER
  OWNER
  PARTNER
}

B2cSubscriptionTopicType

Schema: user, company

The type of a subscription topic

enum B2cSubscriptionTopicType {
  CRITICAL
  NON_CRITICAL
}

B2cSubscriptionType

Schema: user, company

The type of a subscription

enum B2cSubscriptionType {
  EMAIL
  SMS
  VOICE
}

C2cConnectionType

Schema: user, company

The type of a C2C connection

enum C2cConnectionType {
  FAMILY
  FRIEND
  OTHER
  PROFESSIONAL
}

CommunicationDirection

Schema: company

The direction of the external communication message, is it inbound or outbound.

enum CommunicationDirection {
  INBOUND
  OUTBOUND
}

CommunicationType

Schema: company

The type of a external communication message

enum CommunicationType {
  EMAIL
  MESSENGER
  MMS
  RCS
  SIGNAL
  SMS
  TELEGRAM
  VIBER
  WHATSAPP
}

CompanyAddressType

Schema: user, company

The type of a company address

enum CompanyAddressType {
  ACCOUNTING
  BILLING
  HEADQUARTERS
  IT
  LEGAL
  MARKETING
  OPERATIONS
  OTHER
  SALES
  SUPPORT
}

CompanyEmailType

Schema: user, company

The type of a company email

enum CompanyEmailType {
  ACCOUNTING
  BILLING
  HEADQUARTERS
  IT
  LEGAL
  MARKETING
  OPERATIONS
  OPT_OUT_NOTIFICATIONS
  OTHER
  SALES
  SUPPORT
}

CompanyTaxIdType

Schema: user, company

The type of the company tax identifier, e.g. EIN, Sales Tax, etc.

enum CompanyTaxIdType {
  CROATIA_OIB
  EIN
  OTHER
  SALES_TAX_ID
  STATE_INCOME_ID
  UNEMPLOYMENT_ID
  WITHOLDING_TAX_ID
}

CompanyTelephoneNumberType

Schema: user, company

The type of a company telephone number

enum CompanyTelephoneNumberType {
  ACCOUNTING
  BILLING
  HEADQUARTERS
  IT
  LEGAL
  MARKETING
  OPERATIONS
  OPT_OUT_NOTIFICATIONS
  OTHER
  SALES
  SMS_OPT_IN
  SUPPORT
}

CompanyVisibilityType

Schema: user, company

The type of a company visibility

enum CompanyVisibilityType {
  CLIENT
  CUSTOMER
  EMPLOYEE
  PARTNER
  PRIVATE
  PUBLIC
  VENDOR
}

ConnectionRequestResponse

Schema: user, company

enum ConnectionRequestResponse {
  ACCEPTED
  REJECTED
}

ConnectionStatus

Schema: user, company

The status of a connection or a connection request

enum ConnectionStatus {
  ACCEPTED
  PENDING
  REJECTED
  REVOKED
}

DocumentSource

Schema: user, company

How a document entered the repository

enum DocumentSource {
  "Received as an email attachment to the repository address"
  EMAIL
  "Received as an MMS media attachment to the repository number"
  MMS
  "Received as an SMS to the repository number"
  SMS
  "Uploaded through the app"
  UPLOAD
}

DocumentStatus

Schema: user, company

Where a document stands in the repository

enum DocumentStatus {
  "In the repository"
  ACCEPTED
  "Soft-deleted"
  DELETED
  "Received over an inbound channel, awaiting the owner's acceptance"
  PENDING_REVIEW
}

DocumentTaggingError

Schema: user, company

Why a document's contents could not be read

enum DocumentTaggingError {
  "The file could not be opened or its contents could not be parsed"
  CONVERSION_FAILED
  "The file holds no text that could be extracted, such as a scan or a photo of a page"
  NO_TEXT_EXTRACTED
  "Reading the file was attempted and did not complete; the file itself may be fine"
  READING_FAILED
  "The file is larger than can be read"
  TOO_LARGE
}

EmailType

Schema: user, company

The type of an email

enum EmailType {
  ACCOUNTING
  BILLING
  HEADQUARTERS
  HOME
  IT
  LEGAL
  MARKETING
  OPERATIONS
  OPT_OUT_NOTIFICATIONS
  OTHER
  PRIVATE
  SALES
  SUPPORT
  WORK
}

ExternalCommunicationDirection

Schema: company

enum ExternalCommunicationDirection {
  INBOUND
  OUTBOUND
}

ExternalCommunicationType

Schema: company

enum ExternalCommunicationType {
  EMAIL
  MESSENGER
  MMS
  RCS
  SIGNAL
  SMS
  TELEGRAM
  VIBER
  WHATSAPP
}

FormBuilderFieldType

Schema: user, company

enum FormBuilderFieldType {
  CHECKBOX
  DATE
  EMAIL
  IMAGE
  NUMBER
  RADIO
  SELECT
  STATIC_TEXT
  TEXT
  TEXTAREA
  TIME
}

FormBuilderFormInstanceStatus

Schema: user, company

enum FormBuilderFormInstanceStatus {
  ACCEPTED
  CHANGES_REQUESTED
  IN_PROGRESS
  REJECTED
  REQUESTED
  SUBMITTED
}

FormBuilderFormIntendedFor

Schema: user, company

enum FormBuilderFormIntendedFor {
  COMPANY
  USER
}

FormBuilderFormVisibility

Schema: user, company

enum FormBuilderFormVisibility {
  CLIENT
  CUSTOMER
  EMPLOYEE
  PARTNER
  PRIVATE
  PUBLIC
  VENDOR
}

GroupInviteResponse

Schema: user

enum GroupInviteResponse {
  ACCEPTED
  REJECTED
}

GroupInviteStatus

Schema: user

The status of a user group member invite

enum GroupInviteStatus {
  ACCEPTED
  PENDING
  REJECTED
  REVOKED
}

GroupRoleType

Schema: user

The role type of a group member

enum GroupRoleType {
  ADMIN
  MEMBER
}

GroupVisibilityType

Schema: user

The type of a group visibility

enum GroupVisibilityType {
  CONNECTIONS
  PRIVATE
  PUBLIC
}

InputSocialMediaType

Schema: user, company

The type of a social media page

enum InputSocialMediaType {
  FACEBOOK
  INSTAGRAM
  LINKEDIN
  PINTEREST
  SNAPCHAT
  TIKTOK
  X
  YOUTUBE
}

InputWebpageType

Schema: user, company

The type of a webpage

enum InputWebpageType {
  OTHER
  PRIVACY_POLICY
  TERMS_AND_CONDITIONS
  WEBPAGE
}

NotificationKind

Schema: user, company

What a notification is about.

The same vocabulary the notification settings and webhook payloads use, so a caller matching on this is matching on the one the backend already speaks.

enum NotificationKind {
  B2B_CONNECTION_REQUEST
  B2B_FORM_SUBMISSION_REQUEST
  B2C_CONNECTION_REQUEST
  B2C_FORM_SUBMISSION_REQUEST
  B2C_SUBSCRIPTION_REQUEST
  C2B_CONNECTION_REQUEST
  C2C_CONNECTION_REQUEST
  COMPANY_SOCIAL_NETWORK
  GROUP_USER_MEMBER_INVITE
  GROUP_USER_MEMBER_JOIN_REQUEST
  USER_SOCIAL_NETWORK
}

NotificationStatus

Schema: user, company

The read/unread status of a notification

enum NotificationStatus {
  "The notification has been read"
  READ
  "The notification has not been read"
  UNREAD
}

OnboardingStatusValue

Schema: user

enum OnboardingStatusValue {
  COMPLETED
  INCOMPLETE
  SKIPPED
}

OnboardingStep

Schema: user

enum OnboardingStep {
  COMPANY_REGISTERED_STEP
  CONTACT_INFORMATION_STEP
  INTERESTS_INFORMATION_STEP
  INVITED_CONTACTS_STEP
  PERSONAL_INFORMATION_STEP
  SOCIAL_NETWORK_INFORMATION_STEP
}

OnboardingStepStatus

Schema: user

enum OnboardingStepStatus {
  COMPLETED
  SKIPPED
}

OptOutRequestStatus

Schema: company

The status of an opt out request

enum OptOutRequestStatus {
  ACCEPTED
  EXPIRED
  NOTIFIED
  RECEIVED
  REJECTED
  REMINDER_SENT
  REVOKED
}

OptOutRequestType

Schema: company

The type of an opt out request

enum OptOutRequestType {
  EMAIL
  MMS
  SMS
  TNID
  VOICE
  WEB
}

ResponseStatus

Schema: user, company

The status of the request

enum ResponseStatus {
  ERROR
  OK
}

SearchResultType

Schema: user, company

Kind of entity returned by a global search row

enum SearchResultType {
  COMPANY
  GROUP
  USER
}

SentimentAnalysisAction

Schema: company

enum SentimentAnalysisAction {
  NONE
  SUBSCRIBE
  UNSUBSCRIBE
}

SmsOptInQrCodeType

Schema: company

The type of the sms qr code subscription

enum SmsOptInQrCodeType {
  SMS
  VOICE
}

SpamReportChannelType

Schema: user

The channel type of a spam report

enum SpamReportChannelType {
  EMAIL
  MMS
  OTHER
  RCS
  SMS
  VOICE
}

SpamReportIssueType

Schema: user

The issue type of a spam report

enum SpamReportIssueType {
  FRAUD
  HARASSMENT
  ILLEGAL_CONTENT
  SCAM
  SPAM
}

SpamReportStatus

Schema: user

The status of a spam report

enum SpamReportStatus {
  CLOSED
  ESCALATED
  PROCESSING
  REJECTED
  SUBMITTED
}

SubscriptionRequestResponse

Schema: user

enum SubscriptionRequestResponse {
  ACCEPTED
  REJECTED
}

SubscriptionRequestStatus

Schema: user, company

The status of a subscription request

enum SubscriptionRequestStatus {
  ACCEPTED
  PENDING
  REJECTED
  REVOKED
}

TelephoneNumberType

Schema: user, company

The type of an telephone number

enum TelephoneNumberType {
  ACCOUNTING
  BILLING
  HEADQUARTERS
  HOME
  IT
  LEGAL
  MARKETING
  OPERATIONS
  OPT_OUT_NOTIFICATIONS
  OTHER
  PRIVATE
  SALES
  SMS_OPT_IN
  SUPPORT
  WORK
}

TenDlcApiKeyType

Schema: company

10DLC API Key Type

enum TenDlcApiKeyType {
  "Keys that the company is authorized to use from other companies"
  AUTHORIZED
  "Keys that the company owns"
  OWNED
}

TenDlcBrandStatus

Schema: company

enum TenDlcBrandStatus {
  "Brand is active and approved"
  ACTIVE
  "Brand is in draft status"
  DRAFT
  "Brand has expired"
  EXPIRED
  "Brand is pending upstream review"
  PENDING_REVIEW
  "Brand was rejected by upstream"
  REJECTED
}

TenDlcBrandWorkflowStatus

Schema: company

10DLC brand workflow status

enum TenDlcBrandWorkflowStatus {
  "Brand is awaiting upstream identity verification"
  AWAITING_VERIFICATION
  "Brand has been deleted"
  DELETED
  "Brand draft has been created but not submitted"
  DRAFT
  "Brand is in an error state"
  ERROR
  "Brand was rejected upstream"
  REJECTED
  "Brand is being resubmitted upstream"
  RESUBMITTING
  "Brand has been submitted upstream"
  SUBMITTED
  "Brand has been verified upstream"
  VERIFIED
}

TenDlcCampaignStatus

Schema: company

enum TenDlcCampaignStatus {
  "Campaign is active and approved"
  ACTIVE
  "Campaign is in draft status"
  DRAFT
  "Campaign has validation errors"
  ERROR
  "Campaign has expired"
  EXPIRED
  "Campaign is pending approval"
  PENDING
  "Campaign is suspended by MNO"
  SUSPENDED
}

TenDlcCampaignWorkflowStatus

Schema: company

10DLC campaign workflow status

enum TenDlcCampaignWorkflowStatus {
  "Campaign has been deleted"
  DELETED
  "Campaign draft has been created but not submitted"
  DRAFT
  "Campaign is in an error state"
  ERROR
  "Campaign has expired upstream"
  EXPIRED
  "Campaign submission failed and needs manual correction"
  FAILED_SUBMISSION
  "Campaign has been submitted and is awaiting upstream processing"
  SUBMITTED
  "Campaign has been verified and is active upstream"
  VERIFIED
  "Campaign is blocked until its brand finishes verification"
  WAITING_BRAND_VERIFICATION
}

TenDlcComplianceTelephoneNumberStatus

Schema: company

enum TenDlcComplianceTelephoneNumberStatus {
  "Deleted"
  DELETED
  "Initial state"
  DRAFT
  "Error occurred"
  ERROR
  "Rejected by OSR"
  REJECTED
  "Skipped (e.g., deleted campaigns)"
  SKIP
  "Submitted to OSR"
  SUBMITTED
  "Successfully verified"
  VERIFIED
  "Awaiting campaign verification"
  WAITING_CAMPAIGN_VERIFICATION
}

TenDlcEntityType

Schema: company

enum TenDlcEntityType {
  "Government entity"
  GOVERNMENT
  "Non-profit entity"
  NON_PROFIT
  "Private for-profit entity"
  PRIVATE_PROFIT
  "Public for-profit entity"
  PUBLIC_PROFIT
  "Sole proprietor entity"
  SOLE_PROPRIETOR
}

TenDlcOwnershipType

Schema: company

10DLC Brand Ownership Type, indicates if the brand/campaign is owned by the company or shared by a partner company

enum TenDlcOwnershipType {
  "Represents resources created by your 10DLC API Key"
  DIRECT
  "Resource not created by your 10DLC API key but shared by a "partner" company"
  PARTNER
}

UnsubscribeType

Schema: company

To unsubscribe the message, or leave as is.

enum UnsubscribeType {
  DONT_UNSUBSCRIBE
  UNSUBSCRIBE
}

UrlVerificationStatus

Schema: user, company

The verification status of a URL

enum UrlVerificationStatus {
  DEGRADED
  FAILING
  OPERATIONAL
  PENDING
}

UserAddressType

Schema: user

The type of a user address

enum UserAddressType {
  HOME
  PRIVATE
  WORK
}

UserEmailType

Schema: user

The type of a user email

enum UserEmailType {
  HOME
  OTHER
  PRIVATE
  WORK
}

UserImportStatus

Schema: company

The status of a user import job

enum UserImportStatus {
  "The import has completed successfully"
  COMPLETED
  "The import failed with an error"
  ERROR
  "The import is currently being processed"
  PROCESSING
  "The file has been uploaded and is waiting to be processed"
  UPLOADED
}

UserTelephoneNumberType

Schema: user

The type of a user telephone number

enum UserTelephoneNumberType {
  HOME
  OTHER
  PRIVATE
  WORK
}

UserVisibilityType

Schema: user

The type of a user visibility

enum UserVisibilityType {
  FAMILY
  FRIEND
  PRIVATE
  PROFESSIONAL
  PUBLIC
}

VerificationStatus

Schema: user, company

A verification status

enum VerificationStatus {
  UNVERIFIED
  VERIFIED
}

ViewerConnectionStatus

Schema: user, company

Viewer-relative connection state

enum ViewerConnectionStatus {
  "An established connection exists"
  CONNECTED
  "No connection and no pending request"
  NONE
  "A pending request the viewer received and can respond to"
  PENDING_INCOMING
  "A pending request the viewer sent and can revoke"
  PENDING_OUTGOING
  "The viewer is looking at their own profile/company"
  SELF
}

ViewerConnectionType

Schema: user, company

Connection / request type, across all connection directions

enum ViewerConnectionType {
  ADMIN
  CLIENT
  CUSTOMER
  EMPLOYEE
  EXTERNAL_ADMIN
  FAMILY
  FRIEND
  OTHER
  OWNER
  PARTNER
  PROFESSIONAL
  VENDOR
}

VisibilityType

Schema: user, company

Visibility types

enum VisibilityType {
  CLIENT
  CONNECTIONS
  CUSTOMER
  EMPLOYEE
  FAMILY
  FRIEND
  PARTNER
  PRIVATE
  PROFESSIONAL
  PUBLIC
  VENDOR
}

WebpageType

Schema: user, company

The type of a webpage

enum WebpageType {
  FACEBOOK
  INSTAGRAM
  LINKEDIN
  OTHER
  PINTEREST
  PRIVACY_POLICY
  SNAPCHAT
  TERMS_AND_CONDITIONS
  TIKTOK
  WEBPAGE
  X
  YOUTUBE
}