POST /Employees

Servers

https://api.xero.com/api.xro/2.0

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`xero-tenant-id`	String	Yes	Xero identifier for Tenant
`Idempotency-Key`	String	No	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Query parameters

Name Type Required Description

summarizeErrors

Boolean

No

If false return 200 OK and mix of successfully created objects and any with validation errors

Default value: false

Request body fields

Name	Type	Required	Description
`Employees[]`	Array	No
`Employees[].Status`	String	No	Current status of an employee – see contact status types Possible values: `"ARCHIVED"` `"DELETED"` `"ACTIVE"` `"GDPRREQUEST"`
`Employees[].ExternalLink`	Object	No
`Employees[].ExternalLink.LinkType`	String	No	See External link types Possible values: `"Twitter"` `"GooglePlus"` `"Website"` `"LinkedIn"` `"Facebook"`
`Employees[].ExternalLink.Url`	String	No	URL for service e.g. http://twitter.com/xeroapi
`Employees[].ExternalLink.Description`	String	No
`Employees[].StatusAttributeString`	String	No	A string to indicate if a invoice status
`Employees[].ValidationErrors[]`	Array	No	Displays array of validation error messages from the API
`Employees[].ValidationErrors[].Message`	String	No	Validation error message
`Employees[].EmployeeID`	String	No	The Xero identifier for an employee e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
`Employees[].LastName`	String	No	Last name of an employee (max length = 255)
`Employees[].FirstName`	String	No	First name of an employee (max length = 255)
`Employees[].UpdatedDateUTC`	String	No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.