EditSubject

Include name when creating a subject.

Properties

Property	Type	Required	Description
name	string	Yes, for creation	Required. The name of the subject. Nullable.
nickname	string	No	Optional. Another name/alias property for the subject Nullable.
profilePicUrl	string	No	Optional. A profile picture URL for the subject. Nullable.
address	string	No	Optional. The street address of the subject. Nullable.
city	string	No	Optional. The name of the city where the subject lives. Nullable.
state	string	No	Optional. The name of the state name the subject lives. Nullable.
country	string	No	Optional. The name of the country where the subject lives. Nullable.
ageOrDateOfBirth	string	No	Optional. The age or birth date of the subject. Nullable.
email	string	No	Optional. The email address of the subject. Note that this will not be automatically checked for validity. Nullable.
highSchool	string	No	Optional. The name of the high school the subject attended. Nullable.
college	string	No	Optional. The name of the college the subject attended. Nullable.
company	string	No	Optional. The name of the company the subject works for. Nullable.
phone	string	No	Optional. The phone number of the subject. Note that this will not be automatically checked for validity. Nullable.
twitterUrl	string	No	Optional. The URL of the subject’s Twitter profile. Nullable.
facebookUrl	string	No	Optional. The URL of the subject’s Facebook profile. Nullable.
instagramUrl	string	No	Optional. The URL of the subject’s Instagram profile. Nullable.
linkedInUrl	string	No	Optional. The URL of the subject’s LinkedIn profile. Nullable.
tiktokUrl	string	No	Optional. The URL of the subject’s TikTok profile. Nullable.
redditUrl	string	No	Optional. The URL of the subject’s Reddit profile. Nullable.
pinterestUrl	string	No	Optional. The URL of the subject’s Pinterest profile. Nullable.
youtubeUrl	string	No	Optional. The URL of the subject’s YouTube channel. All four channel URL forms are accepted: a handle ({/@name}), a channel id ({/channel/UC…}), and the legacy {/c/name} and {/user/name} forms. The identifier is stored with its prefix, because the forms are not interchangeable and may resolve to different channels. Nullable.
tags	array of string	No	Optional. A set of tags to associate with the subject. Nullable.
notes	string	No	Optional. Free-form notes about the subject, including context for the reviewing analyst. Notes can be read back from Subject.notes and edited in the Ferretly app. Nullable.

Use only the documented fields.