Employee Model

Data model representing a network employee.

NameTypeDescription
accessArrayAn array of permissions that the Employee has. This array contains a value "Brand" that grants base Employee permissions. Other possible permissions are: "Brand.stats" (Ability to view stats, graphs and reports), "Brand.billing" (Ability to view and maintain billing information), "Brand.offer_management" (Ability to edit offer information), "Brand.affiliate_management" (Ability to manage affiliate accounts), "Brand.lead_management" (Ability to manage the conversions for an account/offer), "Brand.global_management" (Ability to use permissions across all accounts and not just specifically accounts the Employee directly manages), "Brand.brand_management" (Ability to manage brand preferences and customization), "Brand.virtual_user" (Ability to virtual user as an affiliate), "Brand.file_management" (Ability to manage offer files), "Brand.offer_monitor_management" (Ability to manage offer monitors), "Brand.alert_management" (Ability to manage alerts), "Brand.dne_management" (Ability to manage DNE lists), "Brand.employee_management" (ability to add,edit,delete employees), "Brand.advertiser_management" (Ability to manage advertiser accounts).
aimNullable StringThe Employee's chat alias
billing_userBooleanWhether or not the Employee can access and modify the Network's HasOffers billing details
cell_phoneNullable StringThe Employee's cell phone
emailStringThe Employee's email address
first_nameNullable StringThe Employee's first name
idIntegerA unique, auto-generated ID for the Employee
This parameter is non-writable
join_dateDatetimeThe date the Employee was created
last_loginNullable DatetimeThe last time the Employee logged into the application
last_nameNullable StringThe Employee's last name
modifiedDatetimeThe last time the Employee account was updated
passwordStringThe Employee's password
password_confirmationStringProvided on creation and must match the provided "password" field
permissionsIntegerThe Employee's permissions stored as a bitmask. See the "access" field for readable permission names. This should not be set or updated directly; instead, the Employee::grantAccess and Employee::removeAccess API functions should be used to grant to, and revoke permissions from, Employees.
phoneNullable StringThe Employee's phone number
photoStringA URL pointing to an image of the Employee's photograph
statusStringThe Employee statusShow Supported Values
titleNullable StringThe Employee's title
wants_alertsBooleanDEPRECATED. This field should be ignored.
Have a Question? Please contact [email protected] for technical support.