Departments

POST /v1/departments/{department_id}/invitations

POST /v1/departments/{department_id}/invitations

Required scopes: invitations:write

post/v1/departments/{department_id}/invitations

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/departments/{department_id}/invitations
  • Auth: HTTP bearer

Path parameters

department_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

emailstring email required
namestring
full_namestring
role'department_lead' | 'recruiter' required
expires_in_hoursinteger

Response

Invitation created and email queued.

idstring required

Display id, e.g. inv_<base32>

object'department_invitation' required
department_idstring required

Display id, e.g. dpt_<base32>

organization_idstring required

Display id, e.g. org_<base32>

emailstring required
namestring nullable required
rolestring required
statusstring required
accepted_atstring nullable required

ISO-8601 UTC

expires_atstring nullable required

ISO-8601 UTC

created_atstring nullable required

ISO-8601 UTC

updated_atstring nullable required

ISO-8601 UTC

membership_createdfalse required

Invitation creation never creates membership; acceptance does.

pending_membership_role'lead' | 'member' required

Changes

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