Employee::create | TUNE Dev Hub

Jump to: POST Response Notes | API Call Builder

Create a network employee.

= Required Parameter

Name

Type

Description

data

Object

Employee model object data propertiesShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
access	Array	An 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).
aim	Nullable String	The Employee's chat alias
billing_user	Boolean	Whether or not the Employee can access and modify the Network's HasOffers billing details
cell_phone	Nullable String	The Employee's cell phone
email	String	The Employee's email address
first_name	Nullable String	The Employee's first name
join_date	Datetime	The date the Employee was created
last_login	Nullable Datetime	The last time the Employee logged into the application
last_name	Nullable String	The Employee's last name
modified	Datetime	The last time the Employee account was updated
password	String	The Employee's password
password_confirmation	String	Provided on creation and must match the provided "password" field
permissions	Integer	The 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.
phone	Nullable String	The Employee's phone number
photo	String	A URL pointing to an image of the Employee's photograph
status	String	The Employee status
title	Nullable String	The Employee's title
wants_alerts	Boolean	DEPRECATED. This field should be ignored.

Show Supported Parameters

return_object

Boolean

If true, returns affected object; defaults to true

POST Response Notes

Returns the ID of the newly created employee as an integer or returns the newly created Employee model object if return_object is "true".

API Call Builder

Javascript is required to use the API Call Builder.