NewSubject
Contains the data needed to create a new subject.
Properties
Section titled “Properties”| Property | Type | Required | Description |
|---|---|---|---|
subjectData | EditSubject | Yes | |
handles | array of ApiSubjectHandle | No | Optional list of ApiSubjectHandle instances to add to the subject. Can be used instead of FacebookUrl, InstagramUrl, or TwitterUrl (for example) to add handles to a subject. Nullable. |
assignToFerretlyAnalyst | boolean | No | Boolean indicating whether to assign the subject to a Ferretly analyst. The organization must have analyst assistance enabled. |
externalSystemId | string | No | Optional but recommended identifier for the subject as it’s known in the source system. This value will be included in webhook notifications and can be used in query methods such as Nullable. |
ownerEmail | string | No | Optional. If the subject should be assigned to a user other than the user associated with the API key, specifies that user’s email address. If the organization does not have a user with the specified email address, then the new subject will be assigned to the user associated with the API key. Nullable. |
document | UploadSubjectDocument | No | |
isDebug | boolean | No | If true, the new subject will NOT BE ADDED to the database. This is useful for testing. |
organizationId | string (uuid) | No | For internal use only. External API clients will not use this property. Organization ID to associate the subject with. If null, then an API key must be provided. Nullable. |
preferencesProfile | string | No | (optional) The name or Guid id of the preference profile to use when creating the subject. If null or not specified, the ‘Default New Subject Profile’ for the registered subscriber (usually the org admin) will be used. Nullable. |
continuousScreening | NewSubjectContinuousScreening | No |
Use only the documented fields.