/locations-directory/staffs

post

https://api.talkdeskapp.com/locations-directory/staffs

Create a new staff

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

staffs-directory:write

Body Params

The staff to create

name

string

required

length between 1 and 9999

The name of staff

description

string

length between 1 and 9999

The description of staff

contacts

array of objects

Employee contact list

contacts

job_title

string

length between 1 and 9999

Professional title (e.g. Mid Market Customer Success Manager)

manager

string

length between 1 and 9999

Name of direct manager

pronouns

string

length between 1 and 9999

Understand the employee pronouns (e.g. she/her, he/his)

specialities

array of strings

The specialties of staff

specialities

external_id

string

length between 1 and 9999

The external id of staff, should be unique

photo_url

string

length between 1 and 9999

The photo url of staff

gender

string

length between 1 and 9999

The gender of staff

status

string

length between 1 and 9999

The status of staff

date_of_birth

string

length between 1 and 9999

The dateOfBirth of staff

date_of_hire

string

length between 1 and 9999

The dateOfHire of staff

languages

array of strings

The languages of staff

languages

attributes

object

The attributes of staff, attributes should be object, and key can be any value

relationships

array of objects

The relationship list of staff

relationships

visit_types

array of objects

The visit type list of staff

visit_types

tag_ids

array of strings

The id list of tag

tag_ids

custom_fields

array of objects

Defaults to []

Custom field values for the staff member.

custom_fields

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

201Staff successfully created

400Bad Request

401Unauthorized

403Forbidden