Skip to content

OrganizationPreferencesProfile

Represents a preference profile applicable to an organization

PropertyTypeRequiredDescription
idstring (uuid)NoThe unique identifier for this profile
profile_namestringNoNullable.
organizationIdstring (uuid)NoThe organization to which this profile belongs
organizationNamestringNoThe name of the organization Nullable.
isOrganizationDefaultProfilebooleanNoWhether or not this profile is the organization default Read-only response field.
subscriberIdstring (uuid)NoIf not null, this is a private profile Nullable.
isPrivateProfilebooleanNoRead-only response field.
isActivebooleanNoSupport soft deletes of profiles
risk_categoriesarray of OrganizationRiskCategoryNoNullable.
key_wordsKeyWordsNo
general_settingsGeneralSettingsNo
disabledPlatformsarray of stringNoA list of social media platforms this profile has turned off. This list is exclusionary: if it is not empty, then handles on those platforms are not scraped and profiles found there are not attached automatically. If the list is empty, every platform applies. Nullable.
lastEditedstring (date-time)No
lastEditedBystring (uuid)NoThe ID of the Subscriber who last edited this profile. Null when the profile was last edited via the external API. Nullable.
lastEditedByNamestringNoThe display name of the person or system that last edited this profile. Populated at write time. For human edits this is “{FirstName} {LastName}”; for external API edits this is the API client’s Owner name. Nullable.

Use only the documented fields.