Pexip Engage API documentation

Create an employee

POST /employees

OAuth2

Create an employee

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
X-Correlation-Id string

Unique identifier to allow referencing a particular transaction or event chain

Minimum length is 1.
Accept-Language string

Returns the requested resources translated according to the passed languages (see translatable resources)

Minimum length is 1.

application/json

Body Required

communicationEmail string | null

Minimum length is 1.
externalId string | null

Minimum length is 1, maximum length is 255.
username string | null

Minimum length is 1, maximum length is 255.
firstName string | null

Minimum length is 1.
lastName string | null

Minimum length is 1.
staticVideoUrl string(uri) | null

Minimum length is 1.
phoneNumber string | null

Minimum length is 1.
profilePictureUrl string(uri) | null

Minimum length is 1.
email string Required

Minimum length is 1.
language string | null

Values are da, de, el, en, es, fr, ja, nl, no, or pl.
timeZone string | null

Minimum length is 1.
availableRoles array[string] | null

Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER. Default value is [] (empty).
status string | null

Values are ACTIVE, PENDING, or SUSPENDED. Default value is PENDING.
onlinePlanning boolean | null

Default value is false.
officeRelations array[object] | null

Default value is [] (empty).
Hide officeRelations attributes Show officeRelations attributes object
- role string Required
  
  Values are AGENT or OFFICE_MANAGER.
- officeId string Required
  
  Minimum length is 1.
- Additional properties are NOT allowed
translations object Required
Hide translations attributes Show translations attributes
- function array[object]
  
  At least 0 elements.
  Hide function attributes Show function attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

• 201 application/json

Successful operation
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes
  
  id string Required
  
  Minimum length is 1.
  
  function object | null Required
  
  Hide function attributes Show function attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  communicationEmail string | null
  
  Minimum length is 1.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  username string | null
  
  Minimum length is 1, maximum length is 255.
  
  firstName string | null
  
  Minimum length is 1.
  
  lastName string | null
  
  Minimum length is 1.
  
  staticVideoUrl string(uri) | null
  
  Minimum length is 1.
  
  phoneNumber string | null
  
  Minimum length is 1.
  
  profilePictureUrl string(uri) | null
  
  Minimum length is 1.
  
  email string Required
  
  Minimum length is 1.
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  timeZone string Required
  
  Minimum length is 1.
  
  availableRoles array[string] Required
  
  Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER.
  
  status string Required
  
  Values are ACTIVE, PENDING, or SUSPENDED.
  
  onlinePlanning boolean Required
  
  officeRelations array[object] Required
  
  Hide officeRelations attributes Show officeRelations attributes object
  
  role string Required
  
  Values are AGENT or OFFICE_MANAGER.
  
  office object Required
  
  Hide office attributes Show office attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  deletedAt string(date-time) | null Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  translations object Required
  
  Hide translations attributes Show translations attributes
  
  function array[object]
  
  At least 0 elements.
  
  Hide function attributes Show function attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 422 application/json
Business validation failed
- EMPLOYEE_EMAIL_ALREADY_IN_USE
- EMPLOYEE_EXTERNAL_ID_ALREADY_IN_USE
- EMPLOYEE_OFFICE_RELATION_ROLE_MISMATCH
- EMPLOYEE_USERNAME_ALREADY_IN_USE
- FILE_URL_INVALID
See Error codes
Hide response attribute Show response attribute object
- errors array[object] Required
  
  At least 1 element.
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  Minimum length is 1.
  
  code string Required
  
  Minimum length is 1.
  
  type string Required
  
  Minimum length is 1.
  
  statusCode string Required
  
  Minimum length is 1.
  
  arguments object | null

POST /employees

curl \
 -X POST https://api.pexipengage.com/enterprises/acme/employees \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *" \
 -d '{"communicationEmail":"john.doe@pexip.com","externalId":"ABCD1234","username":"ABCD1234","firstName":"John","lastName":"Doe","staticVideoUrl":"https://wwww.example.net/abc123","phoneNumber":"+32412345678","profilePictureUrl":"https://wwww.example.net/abc123","email":"john.doe@pexip.com","language":"en","timeZone":"Europe/Brussels","availableRoles":["ADMIN"],"status":"ACTIVE","onlinePlanning":true,"officeRelations":[{"role":"AGENT","officeId":"123"}],"translations":{"function":[{"language":"en","value":"Lorem ipsum"}]}}'

Request example

# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *

# Payload
{
  "communicationEmail": "john.doe@pexip.com",
  "externalId": "ABCD1234",
  "username": "ABCD1234",
  "firstName": "John",
  "lastName": "Doe",
  "staticVideoUrl": "https://wwww.example.net/abc123",
  "phoneNumber": "+32412345678",
  "profilePictureUrl": "https://wwww.example.net/abc123",
  "email": "john.doe@pexip.com",
  "language": "en",
  "timeZone": "Europe/Brussels",
  "availableRoles": [
    "ADMIN"
  ],
  "status": "ACTIVE",
  "onlinePlanning": true,
  "officeRelations": [
    {
      "role": "AGENT",
      "officeId": "123"
    }
  ],
  "translations": {
    "function": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ]
  }
}

Response examples (201)

{
  "data": {
    "id": "123",
    "function": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "communicationEmail": "john.doe@pexip.com",
    "externalId": "ABCD1234",
    "username": "ABCD1234",
    "firstName": "John",
    "lastName": "Doe",
    "staticVideoUrl": "https://wwww.example.net/abc123",
    "phoneNumber": "+32412345678",
    "profilePictureUrl": "https://wwww.example.net/abc123",
    "email": "john.doe@pexip.com",
    "language": "en",
    "timeZone": "Europe/Brussels",
    "availableRoles": [
      "ADMIN"
    ],
    "status": "ACTIVE",
    "onlinePlanning": true,
    "officeRelations": [
      {
        "role": "AGENT",
        "office": {
          "id": "123"
        }
      }
    ],
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "translations": {
      "function": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}

Response examples (422)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}