> ## Documentation Index > Fetch the complete documentation index at: https://klef.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Replace a policy's document. > The name, category and segment are read out of the document, so a document that does not compile is refused and nothing is written. The answer carries the warnings the document compiled with and what the next plan does differently because of the save. ## OpenAPI ````yaml /openapi-public.json put /policies/{id} openapi: 3.1.1 info: title: Klef API description: Klef's multi-tenant HRIS sync platform API. version: v1 servers: - url: https://{workspace}.klef.ai/api variables: workspace: default: acme description: Your workspace's subdomain. security: [] tags: - name: Users - name: Connections - name: Adoption - name: Policy resources - name: Audit - name: Catalog - name: Sync - name: Search - name: SyncPlans - name: Agent - name: Auth - name: Workspaces - name: Billing - name: Invitations - name: FirstSignIns - name: Connection accounts - name: Policies - name: Secrets - name: Lookup tables - name: Scripts - name: Segments - name: ApiKeys - name: Members - name: Workers - name: Inbox - name: Notifications paths: /policies/{id}: put: tags: - Policies summary: Replace a policy's document. description: >- The name, category and segment are read out of the document, so a document that does not compile is refused and nothing is written. The answer carries the warnings the document compiled with and what the next plan does differently because of the save. operationId: SavePolicy parameters: - name: id in: path required: true schema: type: string format: uuid - name: If-Match in: header description: >- Strong ETag (e.g. "3") of the resource's current version, from the most recent GET or write. Required for the write to proceed; a missing header returns 428, a malformed value returns 400. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SavePolicyRequest' required: true responses: '200': description: OK headers: ETag: description: >- Strong ETag for the resource's current version. Send back as `If-Match` on the next write to assert the version observed. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApiResponseOfSavePolicyResponse' '400': description: Validation or business-rule error. content: application/json: schema: required: - result - errors type: object properties: result: {} errors: type: array items: required: - errorCode - errorMessage type: object properties: errorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: >- The central catalog of every error returned by the API. errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." '401': description: Authentication required. content: application/json: schema: required: - result - errors type: object properties: result: {} errors: type: array items: required: - errorCode - errorMessage type: object properties: errorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: >- The central catalog of every error returned by the API. errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." '403': description: Permission denied. content: application/json: schema: required: - result - errors type: object properties: result: {} errors: type: array items: required: - errorCode - errorMessage type: object properties: errorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: >- The central catalog of every error returned by the API. errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." '412': description: >- If-Match did not match the current resource version; reload and retry. content: application/json: schema: required: - result - errors type: object properties: result: {} errors: type: array items: required: - errorCode - errorMessage type: object properties: errorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: >- The central catalog of every error returned by the API. errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." '428': description: If-Match header is required. content: application/json: schema: required: - result - errors type: object properties: result: {} errors: type: array items: required: - errorCode - errorMessage type: object properties: errorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: >- The central catalog of every error returned by the API. errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." '500': description: Internal server error. content: application/json: schema: required: - result - errors type: object properties: result: {} errors: type: array items: required: - errorCode - errorMessage type: object properties: errorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: >- The central catalog of every error returned by the API. errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." security: - cookieAuth: [] - apiKeyAuth: [] components: schemas: SavePolicyRequest: required: - source type: object properties: source: minLength: 1 type: string ApiResponseOfSavePolicyResponse: required: - result - errors type: object properties: result: oneOf: - type: 'null' - $ref: '#/components/schemas/SavePolicyResponse' errors: type: array items: $ref: '#/components/schemas/ApiError' description: "The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise `null`\r\n with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors." SavePolicyResponse: required: - version - revision - diagnostics type: object properties: version: type: integer format: int32 revision: type: integer format: int32 diagnostics: type: array items: $ref: '#/components/schemas/PolicyDiagnosticResponse' ApiError: required: - errorCode - errorMessage type: object properties: errorCode: $ref: '#/components/schemas/ApiErrorCode' errorMessage: type: string target: type: - 'null' - string description: "One error in an API response: a specific ApiErrorCode, a human-readable message,\r\n and an optional string? ApiError.Target (the field a validation error applies to)." PolicyDiagnosticResponse: required: - code - severity - message - start - end - candidates - unresolved type: object properties: code: type: string severity: $ref: '#/components/schemas/PolicyDiagnosticSeverity' message: type: string start: type: integer format: int32 end: type: integer format: int32 candidates: type: array items: type: string unresolved: oneOf: - type: 'null' - $ref: '#/components/schemas/PolicyReferenceKind' description: "One problem found in the document. Start and End are\r\nUTF-16 offsets into the source the caller posted, and Candidates holds what\r\ncould have been written instead, so an editor can offer one as a fix. Unresolved\r\nis the kind of resource the document names and the workspace does not hold, when that is the\r\nproblem." ApiErrorCode: enum: - validation_error - unauthorized - forbidden - not_found - internal_error - error - precondition_required - precondition_failed - invalid_if_match - worker_not_found - worker_version_not_found - connection_not_found - policy_not_found - policy_revision_not_found - lookup_table_not_found - script_not_found - segment_not_found - workspace_secret_not_found - member_not_found - invitation_not_found - user_not_found - workspace_not_found - api_key_not_found - inbox_item_not_found - sync_plan_not_found - connection_account_not_found - managed_account_not_found - adoption_run_not_found - sync_plan_not_ready - sync_plan_stale - sync_plan_already_applying - subdomain_taken - invalid_subdomain - invalid_invite - last_owner_protected - owner_protected - already_member - already_invited - role_not_assignable - invalid_email - email_required - email_mismatch - invitation_gone - invalid_connector_credentials - wrong_connector_type - connection_not_syncable - connector_o_auth_not_configured - connector_authorization_failed - salesforce_manage_users_required - box_admin_required - linear_admin_required - dropbox_admin_required - invalid_match_rule - adoption_run_composed - adoption_run_empty - adoption_selection_refused - invalid_policy - policy_does_not_compile - policy_secret_missing - policy_lookup_table_missing - policy_script_missing - policy_segment_missing - policy_edit_target_missing - policy_secret_disclosure_forbidden - notification_send_failed - invalid_workspace_secret - workspace_secret_referenced - workspace_secret_name_conflict - invalid_lookup_table - lookup_table_referenced - lookup_table_name_conflict - invalid_script - script_name_conflict - script_referenced - invalid_segment - segment_name_conflict - segment_referenced - segment_worker_missing - api_key_scope_not_granted - api_key_limit_reached - subscription_required - already_subscribed - no_billing_customer - workspace_pending_deletion - workspace_deletion_confirmation_mismatch - workspace_deletion_already_scheduled - workspace_deletion_not_scheduled - workspace_export_expired - workspace_export_not_found - agent_conversation_not_found - agent_proposal_not_found - agent_proposal_outdated - agent_proposal_expired - agent_proposal_already_applied - agent_proposal_rejected - notification_kind_unsupported - first_sign_in_not_found - first_sign_in_gone - first_sign_in_not_a_recipient - first_sign_in_recipient_unknown - first_sign_in_locked - first_sign_in_code_refused - first_sign_in_proof_invalid - password_reset_unsupported - invalid_password_rules - avatar_not_owned - unsupported_image_type - image_too_large description: The central catalog of every error returned by the API. PolicyDiagnosticSeverity: enum: - error - warning - info description: How much a diagnostic matters. PolicyReferenceKind: enum: - segment - lookup - script - secret description: The kinds of workspace resource a document reaches by identifier. securitySchemes: cookieAuth: type: apiKey description: >- Cookie-based session. Obtain by completing the `/auth/login/{provider}` OAuth flow; the `/auth/callback` response sets the `klef.session` cookie that subsequent requests send automatically. name: klef.session in: cookie apiKeyAuth: type: http description: >- An API key from **Settings > API keys**, sent as `Authorization: Bearer klef_sk_…`. A key works only on its own workspace's subdomain, and only with the permissions its scopes grant. scheme: bearer bearerFormat: klef_sk_… ````