---
title: "/members/invite"
method: POST
path: "/members/invite"
---

# /members/invite

`POST /members/invite`

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

## Path parameters

- `subdomain` string, required

## Request body

- object
  - `email` string, required — The email of the new member
  - `roles` string[], 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_id` string — Mandatory in case of using an account-wide access token. This identifier specifies the member who is sending this invitation
  - `collaboration_rules` object[] — The member's collaboration rules
    - `role` string — The role the member will have in this collaboration. Possible values are admin, recruiting_admin, hiring_manager, simple, reviewer. More info [here](https://workable.readme.io/reference/collaboration-rules#/role)
    - `departments` object[] — The departments this collaboration rule will apply to
      - `any` boolean — If any is set to true, it acts as a wildcard that enables this collaboration rule regardless of the department. If this is set to true you should ignore the following properties
      - `id` string — The identifier of the department
    - `locations` object[] — The locations this collaboration rule will apply to
      - `any` boolean — If any is true, it acts as a wildcard that enables the collaboration_rule regardless of location. If it is set to true you should ignore the following properties as well.
      - `country_code` string — The ISO 3166-1 alpha-2 code (e.g. US)
      - `city` string — The name of the city (e.g. Seattle)
      - `state_code` string — The code of the state, if applicable, (e.g. WA)
      - `subregion` string — The name of the subregion, if applicable
      - `zip_code` string — The zip code of the location, if applicable (e.g. 98119)
      - `location_string` string — The string representation of the location (e.g. Seattle, Washington, U.S.)
      - `country_name` string — The name of the country (e.g. United States of America)
      - `center` string — The latitude and longitude of the location seperated by a comma (e.g. "47.6038, -122.3301" for Downtown Seattle)

## Response `201`

201

- object
  - `id` string
  - `email` string
  - `roles` string[]
  - `collaboration_rules` unknown[]
    - unknown

## Other responses

- `401` — 401
- `403` — 403
- `422` — 422

---

[API](https://skmtc.net/workable/apis/account-root.md) · [All operations](https://skmtc.net/workable/apis/account-root/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workable/account-root/versions/3ead9ec42165/schema)