Pexip Engage API documentation

Create an office

POST /offices

OAuth2

Create an office

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

email string | null

Minimum length is 1.
externalId string | null

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

Minimum length is 1.
active boolean | null

Default value is false.
virtual boolean | null

Default value is false.
timeZone string | null

Minimum length is 1.
usesIndependentAgents boolean | null
translations object Required
Hide translations attributes Show translations attributes
- name array[object] Required
  
  At least 1 element.
  Hide name attributes Show name 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
- description array[object]
  
  At least 0 elements.
  Hide description attributes Show description 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
- directions array[object]
  
  At least 0 elements.
  Hide directions attributes Show directions 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
- parkingInfo array[object]
  
  At least 0 elements.
  Hide parkingInfo attributes Show parkingInfo 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
location object Required
Hide location attributes Show location attributes
- postalCode string | null
  
  Minimum length is 1.
- countryCode string Required
  
  Minimum length is 2, maximum length is 2.
- geolocation object | null
  Hide geolocation attributes Show geolocation attributes
  
  latitude number Required
  
  Minimum value is -90, maximum value is 90.
  
  longitude number Required
  
  Minimum value is -180, maximum value is 180.
  
  Additional properties are NOT allowed
- translations object Required
  Hide translations attributes Show translations attributes
  
  city array[object] Required
  
  At least 1 element.
  
  Hide city attributes Show city 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
  
  state array[object]
  
  At least 0 elements.
  
  Hide state attributes Show state 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
  
  street1 array[object] Required
  
  At least 1 element.
  
  Hide street1 attributes Show street1 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
  
  street2 array[object]
  
  At least 0 elements.
  
  Hide street2 attributes Show street2 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
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.
  
  name object | null Required
  
  Hide name attributes Show name 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
  
  description object | null Required
  
  Hide description attributes Show description 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
  
  directions object | null Required
  
  Hide directions attributes Show directions 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
  
  parkingInfo object | null Required
  
  Hide parkingInfo attributes Show parkingInfo 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
  
  email string | null
  
  Minimum length is 1.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  phoneNumber string | null
  
  Minimum length is 1.
  
  active boolean Required
  
  virtual boolean Required
  
  timeZone string Required
  
  Minimum length is 1.
  
  usesIndependentAgents boolean Required
  
  employeeRelations array[object] Required
  
  Hide employeeRelations attributes Show employeeRelations attributes object
  
  role string Required
  
  Values are AGENT or OFFICE_MANAGER.
  
  employee object Required
  
  Hide employee attributes Show employee 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.
  
  location object Required
  
  Hide location attributes Show location attributes
  
  city object | null Required
  
  Hide city attributes Show city 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
  
  state object | null Required
  
  Hide state attributes Show state 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
  
  street1 object | null Required
  
  Hide street1 attributes Show street1 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
  
  street2 object | null Required
  
  Hide street2 attributes Show street2 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
  
  postalCode string | null
  
  Minimum length is 1.
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  formattedAddress string Required
  
  Minimum length is 1.
  
  geolocation object Required
  
  Hide geolocation attributes Show geolocation attributes
  
  latitude number Required
  
  Minimum value is -90, maximum value is 90.
  
  longitude number Required
  
  Minimum value is -180, maximum value is 180.
  
  Additional properties are NOT allowed
  
  translations object Required
  
  Hide translations attributes Show translations attributes
  
  city array[object] Required
  
  At least 1 element.
  
  Hide city attributes Show city 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
  
  state array[object]
  
  At least 0 elements.
  
  Hide state attributes Show state 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
  
  street1 array[object] Required
  
  At least 1 element.
  
  Hide street1 attributes Show street1 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
  
  street2 array[object]
  
  At least 0 elements.
  
  Hide street2 attributes Show street2 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
  
  translations object Required
  
  Hide translations attributes Show translations attributes
  
  name array[object] Required
  
  At least 1 element.
  
  Hide name attributes Show name 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
  
  description array[object]
  
  At least 0 elements.
  
  Hide description attributes Show description 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
  
  directions array[object]
  
  At least 0 elements.
  
  Hide directions attributes Show directions 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
  
  parkingInfo array[object]
  
  At least 0 elements.
  
  Hide parkingInfo attributes Show parkingInfo 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
- LOCATION_GEOCODING_FAILED
- LOCATION_TIME_ZONE_RESOLUTION_FAILED
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 /offices

curl \
 -X POST https://api.pexipengage.com/enterprises/acme/offices \
 -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 '{"email":"john.doe@pexip.com","externalId":"ABCD1234","phoneNumber":"+32412345678","active":true,"virtual":true,"timeZone":"Europe/Brussels","usesIndependentAgents":true,"translations":{"name":[{"language":"en","value":"Lorem ipsum"}],"description":[{"language":"en","value":"Lorem ipsum"}],"directions":[{"language":"en","value":"Lorem ipsum"}],"parkingInfo":[{"language":"en","value":"Lorem ipsum"}]},"location":{"postalCode":"9000","countryCode":"BE","geolocation":{"latitude":51.0479466,"longitude":3.6912248},"translations":{"city":[{"language":"en","value":"Lorem ipsum"}],"state":[{"language":"en","value":"Lorem ipsum"}],"street1":[{"language":"en","value":"Lorem ipsum"}],"street2":[{"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
{
  "email": "john.doe@pexip.com",
  "externalId": "ABCD1234",
  "phoneNumber": "+32412345678",
  "active": true,
  "virtual": true,
  "timeZone": "Europe/Brussels",
  "usesIndependentAgents": true,
  "translations": {
    "name": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ],
    "description": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ],
    "directions": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ],
    "parkingInfo": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ]
  },
  "location": {
    "postalCode": "9000",
    "countryCode": "BE",
    "geolocation": {
      "latitude": 51.0479466,
      "longitude": 3.6912248
    },
    "translations": {
      "city": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "state": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "street1": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "street2": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}

Response examples (201)

{
  "data": {
    "id": "123",
    "name": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "description": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "directions": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "parkingInfo": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "email": "john.doe@pexip.com",
    "externalId": "ABCD1234",
    "phoneNumber": "+32412345678",
    "active": true,
    "virtual": true,
    "timeZone": "Europe/Brussels",
    "usesIndependentAgents": true,
    "employeeRelations": [
      {
        "role": "AGENT",
        "employee": {
          "id": "123"
        }
      }
    ],
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "location": {
      "city": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "state": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street1": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street2": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "postalCode": "9000",
      "countryCode": "BE",
      "formattedAddress": "string",
      "geolocation": {
        "latitude": 51.0479466,
        "longitude": 3.6912248
      },
      "translations": {
        "city": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "state": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street1": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street2": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      }
    },
    "translations": {
      "name": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "description": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "directions": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "parkingInfo": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}

Response examples (422)

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