# Update policy

Updates a specific policy.

Endpoint: PUT /api/v1/organizations/{organizationId}/policies/{policyId}
Version: v1
Security: Bearer, PersonalAccessToken

## Security:

  - `Bearer` (unknown)
    http bearer JWT

  - `PersonalAccessToken` (unknown)
    apiKey in header Personal-Access-Token

## Path parameters:

  - `organizationId` (string, required)
    Unique identifier of the organization

  - `policyId` (string, required)

## Request fields (application/json):

  - `name` (string, required)
    The policy name.
    Example: Standard signing policy

  - `isActive` (boolean, required)
    Whether the policy is active.
    Example: true

  - `description` (string)
    The policy description.
    Example: Policy applied to all standard signing envelopes

  - `documentClassId` (string)
    The document class this policy applies to, when set.

  - `conditions` (array, required)
    The policy's conditions. `sortOrder` must start at 1, be unique, and contiguous within the list.

  - `conditions.operator` (string, required)
    The comparison operator applied by a policy condition.
    Enum: "GreaterThan", "LessThan", "Equals"

  - `conditions.sortOrder` (integer, required)
    The condition's position within the policy. Must start at 1, be unique, and contiguous within the conditions list.
    Example: 1

  - `conditions.metadata` (any, required)
    The document metadata field this condition evaluates, and its comparison value, discriminated by the `type` property.

  - `conditions.metadata.id` (string, required)
    The document metadata field ID this condition evaluates.

  - `conditions.metadata.value` (string, required)
    The comparison text value.

  - `conditions.metadata.value` (number, required)
    The comparison numeric value.

  - `conditions.metadata.value` (string, required)
    The comparison date value.

  - `conditions.metadata.value` (string, required)
    The comparison list option id (not its display text/label).

  - `actions` (array, required)
    The policy's actions. `sortOrder` must start at 1, be unique, and contiguous within the list.

  - `actions.sortOrder` (integer, required)
    The action's position within the policy. Must start at 1, be unique, and contiguous within the actions list.

  - `actions.stage` (object, required)
    The stage configuration applied by a policy action.

  - `actions.stage.name` (string, required)
    The stage name.

  - `actions.stage.type` (string, required)
    The type of a stage, derived from recipient types.
    Enum: "Signer", "CarbonCopy", "Viewer", "Automatic", "Approver"

  - `actions.stage.requiredRecipientCompletions` (integer, required)
    Number of recipients required to complete the stage.
    Example: 1

  - `actions.recipientSource` (any, required)
    The action's recipient source, discriminated by the `type` property.

  - `actions.recipientSource.recipients` (array)
    The fixed list of recipients. Required, and used only when Modules.DocumentClasses.Core.Models.StaticPolicyRecipientSourceRequest.Type is `Static`.

  - `actions.recipientSource.recipients.givenName` (string, required)
    The recipient's given name.

  - `actions.recipientSource.recipients.surname` (string, required)
    The recipient's surname.

  - `actions.recipientSource.recipients.email` (string, required)
    The recipient's email address.

  - `actions.recipientSource.recipients.phoneNumber` (string)
    The recipient's phone number.

  - `actions.recipientSource.userGroupId` (string)
    The user group ID recipients are resolved from, when set.

  - `actions.recipientSource.businessRoleId` (string)
    The business role ID recipients are resolved from, when set.

## Request examples:

  - `minimal (no conditions or actions)` (unknown)

  - `condition - StringType` (unknown)

  - `condition - NumberType` (unknown)

  - `condition - DateType` (unknown)

  - `condition - ListOptionType` (unknown)

  - `action - recipientSource Static` (unknown)

  - `action - recipientSource Dynamic` (unknown)

  - `complete (conditions and actions)` (unknown)

## Response 204:

  - `204` (unknown)
    No Content

## Response 400:

  - `400` (unknown)
    Bad Request

## Response 400 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 404:

  - `404` (unknown)
    Not Found

## Response 404 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 422:

  - `422` (unknown)
    Unprocessable Content

## Response 422 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 500:

  - `500` (unknown)
    Internal Server Error

## Response 500 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

