Skip to main content
POST
/
workers
/
transferred-workers
Add Transferred Workers
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/workers/transferred-workers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "name_first": "<string>",
    "name_last": "<string>",
    "email": "<string>",
    "formatted_name": "<string>",
    "phone": "<string>",
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "applied_position": "<string>",
    "document_links": [
      {
        "link": "<string>",
        "name": "<string>",
        "type": "<string>"
      }
    ],
    "documents": [
      {
        "file": "<string>",
        "name": "<string>",
        "type": "<string>"
      }
    ]
  }
]
'
{
  "workers_transferred": 11
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Array of worker objects

Required array length: 1 - 100 elements
​
name_first
string
required
Required string length: 1 - 255
​
name_last
string
required
Required string length: 1 - 255
​
email
string
required
Required string length: 1 - 255
​
formatted_name
string
Required string length: 1 - 255
​
phone
string
Required string length: 1 - 255
​
address
string
Required string length: 1 - 255
​
city
string
Required string length: 1 - 255
​
zip
string
Required string length: 1 - 255
​
applied_position
string
Required string length: 1 - 255
​
document_links
object[]
​
documents
object[]

Response

OK

​
workers_transferred
integer

Number of workers successfully transferred.

Required range: 1 <= x <= 100