WOworkable

/members/invite

Invites a member. Required scope: w_members. Accessible with all token types.

post/members/invite

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/members/invite
  • Auth
    API key in header Authorization

Path parameters

subdomainstring required

The account subdomain

Request body

emailstring required

The email of the new member

rolesstring[] required

The member's roles in an array. Possible values are ats.admin, ats.simple, ats.reviewer, hris.admin, hris.employee, hris.limited, workable.superadmin plus any permission sets assigned to the member.

member_idstring

Mandatory in case of using an account-wide access token. This identifier specifies the member who is sending this invitation

Response

201

idstring
emailstring
rolesstring[]

Example response

{
  "id": "196b",
  "email": "john.doe@workable.com"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.