Update the organization settings
Changes the name, the candidate feedback settings and the report and interview versions new work uses. candidateFeedback turns candidate feedback on or off for the organization, sets which sections a new draft starts with and whether it includes the practice link; only the fields you send change. Turning feedback off refuses drafting, editing and sending (candidate_feedback_disabled) but does not touch drafts or links that exist: reading and revoking still work, and links already released keep working until revoked or expired. Choosing a version changes what new reports and interviews cost, so this needs organization:write, and the key's owner must still be an admin (permission_denied otherwise). Every version is checked before anything is written: one that is not in available, or not in the pricing plan, is refused with version_not_available and nothing changes. Choosing the assigned version is a no-op. Reports and interviews already created keep their version. Returns the settings after the change.
Required scope: organization:write.
Errors
- 400:
invalid_content_type,invalid_json,request_body_too_large,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope,permission_denied - 422:
invalid_parameter,version_not_available - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>application/json- body
name?stringThe organization's name, 1 to 100 characters.
1 <= length <= 100versions?Change which versions new work uses. Existing reports and interviews keep the version they were created with.
candidateFeedback?Change how candidate feedback behaves. Only the fields you send change.
Success.
application/json- response
object*stringid*stringThe organization's ID.
name*stringThe organization's name.
billingMode*stringDecides whether credits or quotaWeight describes a run.
"credits""quota"candidateFeedback*How candidate feedback behaves for the organization. Change it with candidateFeedback on the update.
versions*The versions new reports and interviews use. Existing ones keep theirs.
available*The versions the organization may choose, as the app lists them. The assigned one is always included.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X PATCH "$PROBB_URL/api/v1/organization/settings" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "name": "Acme Hiring", "versions": { "report": "report-v1-evidence" }, "candidateFeedback": { "enabled": true, "defaultSections": { "skills": false }, "includePractice": null }}'{ "object": "organization_settings", "id": "string", "name": "string", "billingMode": "credits", "candidateFeedback": { "enabled": true, "defaultSections": { "strengths": true, "resume": true, "interview": true, "skills": true }, "includePractice": true }, "versions": { "report": { "id": "string", "label": "string", "state": "released", "whenToUse": "string" }, "interview": { "id": "string", "label": "string", "state": "released", "whenToUse": "string", "capabilities": { "recording": true, "speakerVerification": true } } }, "available": { "report": [ { "id": "string", "label": "string", "state": "released", "whenToUse": "string", "available": true, "unavailableReason": "string", "quotaWeight": 0, "credits": 0 } ], "interview": [ { "id": "string", "label": "string", "state": "released", "whenToUse": "string", "available": true, "unavailableReason": "string", "quotaWeight": 0, "credits": 0 } ] }}