GRgreenhouse
Future Job Permissions

Create future job permission

Grant a user a Job Admin role on future jobs matching an optional department and/or office scope. Pass department_id (or external_department_id) and/or office_id (or external_office_id) to restrict the scope; omit all four to grant the role on every future job in the organization. The role_id must reference a Job Admin organization role. Site admins already have access to every non-confidential job, so creating a future job permission for a site admin is a no-op and returns 204 No Content instead of 201 Created.

post/v3/future_job_permissions

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/future_job_permissions
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:future_job_permissions:create
    • or HTTP bearer

Request body

department_idinteger

Id of the department to scope this permission to. Future jobs created in this department (optionally combined with office_id) will grant the user the specified role. Mutually exclusive with external_department_id. Omit both department fields and both office fields to grant the role on every future job in the organization.

external_department_idstring

Partner-supplied external_id of the department to scope this permission to. Resolved to a Greenhouse department_id in the caller's organization; unknown values are rejected. Mutually exclusive with department_id.

user_idinteger required

Id of the user who should receive the role on matching future jobs. Must reference a user in the caller's organization.

office_idinteger

Id of the office to scope this permission to. Future jobs created in this office (optionally combined with department_id) will grant the user the specified role. Mutually exclusive with external_office_id. Omit both office fields and both department fields to grant the role on every future job in the organization.

external_office_idstring

Partner-supplied external_id of the office to scope this permission to. Resolved to a Greenhouse office_id in the caller's organization; unknown values are rejected. Mutually exclusive with office_id.

role_idinteger required

Id of the Job Admin organization role to grant on matching future jobs. Must reference a Job Admin role in the caller's organization; other role types are rejected.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
department_idinteger nullable

Id of the department this permission is scoped to. References a /v3/departments row. When both department_id and office_id are null, the permission applies to every future job in the organization; when set, only future jobs in this department (optionally combined with office_id) grant the role.

user_idinteger

Id of the user who will receive the role on matching future jobs. References a /v3/users row.

office_idinteger nullable

Id of the office this permission is scoped to. References a /v3/offices row. When both office_id and department_id are null, the permission applies to every future job in the organization; when set, only future jobs in this office (optionally combined with department_id) grant the role.

role_idinteger

Id of the Job Admin organization role the user will be assigned on matching future jobs. References a /v3/organization_roles row; future job permissions can only be granted for Job Admin roles.

Changes

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