Collaboration Rules

Collaboration Rules

collaboration_rules(Array of Objects):

This property appears in the response of GET /members and requests of PUT /members and POST /members/invite. It defines the collaboration permissions for a member.

Each collaboration_rule object has the following properties:

• role (String, Required): The member's role within the collaboration. Possible values: "admin", "recruiting_admin", "hiring_manager", "simple" and "reviewer"
• departments (Array, Optional): The departments this rule applies to
• locations (Array, Optional): The locations this rule applies to

Role

• If the member has admin role assigned, then the member can only be assigned the admin role in a collaboration rule
• If the member has reviewer role assigned, then the member can only be assigned the reviewer role in a collaboration rule
• If the member has simple role assigned, then the member can only be assigned one of the following roles in a collaboration rule: recruiting_admin, hiring_manager, simple, and reviewer

Note: In case of using an invalid combination of member role and collaboration rule role, the collaboration rule will be invalid and ignored as a result. However, the corresponding request will succeed.

Department

A department object within departments can have these properties:

• any (Boolean, Optional): If true, applies to all departments. The id property is ignored in this case
• id (String, Optional): The ID of a specific department (used when any is false)
• name (String): Only applies in the GET /members request and represents the department's name

For managing departments, refer to the relevant endpoints

Note: In case of using an invalid department id, the collaboration rule will be invalid and ignored as a result. However, the corresponding request will succeed.

Location

A location object within locations can have these properties:

• any (Boolean, Optional): If true, applies to all locations. All other location properties are ignored
• country_code (String, Optional): ISO 3166-1 alpha-2 country code (e.g., "US", "GB")
• city (String, Optional): The city name (e.g., "Seattle")
• state_code (String, Optional): State code (e.g., "WA")
• subregion (String, Optional): Subregion name
• zip_code (String, Optional): ZIP code
• location_string (String, Optional): The string representation of the location
• country_name (String, Optional): The full country name (e.g., "United States of America")

Examples

1. Rule for all departments and locations (Wildcard):

JSON

[
  {
    "role": "admin",
    "departments": [
      {
        "any": true
      }
    ],
    "locations": [
      {
        "any": true
      }
    ]
  }
]

2. Rule for a specific department and location (Seattle):

JSON

[
  {
    "role": "reviewer",
    "departments": [
      {
        "id": "3ff4d641"
      }
    ],
    "locations": [
      {
        "country_code": "US",
        "city": "Seattle",
        "state_code": "WA",
        "center": "47.6038, -122.3301"
      }
    ]
  }
]

3. Rule for multiple departments and specific countries:

JSON

[
  {
    "role": "simple",
    "departments": [
      {
        "id": "3ff4d642"
      },
      {
        "id": "3ff4d649"
      }
    ],
    "locations": [
      {
        "country_code": "US"
      }
    ]
  }
]