WIwirexapp
Employees

Invite employee

Invites a new employee to the corporation with personal data, manager address, and residence address.

post/api/v1/employees/invite

Request

  • Base URL
    https://api-business.wirexapp.com
  • URL
    https://api-business.wirexapp.com/api/v1/employees/invite
  • Auth
    API key in header Authorization

Request body */*

departmentstring

Optional employee department

emailstring required

Email address of the employee

first_namestring required

Employee first name

job_titlestring

Optional employee job title

last_namestring required

Employee last name

manager_addressstring

Optional employee manager address

phonestring

Optional employee phone number

role_idstring required

Role id assigned to employee

Example request

{
  "department": "Finance",
  "email": "a.white@acme.com",
  "first_name": "Alex",
  "job_title": "Analyst",
  "last_name": "Grey",
  "manager_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "phone": "+15551234567",
  "residence_address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "123 Main St",
    "line2": "Apt 101",
    "postal_code": "94107",
    "state": "CA"
  },
  "role_id": "00000000-0000-0000-0000-000000000001"
}

Response

OK

ResponseEmptyResponse required

Changes

No recorded changes to this operation across all 1 revision of this API.