# Update Schedules

Updates schedules in AML monitoring.

Endpoint: PUT /compliance/kyc-protect/schedules
Version: 1.10.9
Security: bearerToken

## Request fields (application/json):

  - `items` (array)

  - `items.threshold` (integer)
    The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.
Changing threshold will cause even decided results to come back again and a new
decision will need to be made.

  - `items.datasets` (array)
    The datasets to use when running the schedule.
Changing datasets will cause even decided results to come back again and a new
decision will need to be made.

  - `items.isEmailRequired` (boolean)
    Set to true to send an email when the schedule is run. If there are no email recipients set then
this will be ignored.

  - `items.emailRecipients` (array)
    The list of email recipients to send the email to when the schedule is run. Email will not be sent IsEmailRequired is false.

  - `items.scheduleId` (string)
    The id of the schedule to be updated

## Response 200 fields (application/json):

  - `failed` (array)

  - `failed.failedItem` (object)

  - `failed.failedItem.threshold` (integer)
    The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.
Changing threshold will cause even decided results to come back again and a new
decision will need to be made.

  - `failed.failedItem.datasets` (array)
    The datasets to use when running the schedule.
Changing datasets will cause even decided results to come back again and a new
decision will need to be made.

  - `failed.failedItem.isEmailRequired` (boolean)
    Set to true to send an email when the schedule is run. If there are no email recipients set then
this will be ignored.

  - `failed.failedItem.emailRecipients` (array)
    The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.

  - `failed.failedItem.scheduleId` (string)
    The id of the schedule to be updated

  - `failed.error` (object)

  - `failed.error.type` (string)

  - `failed.error.title` (string)

  - `failed.error.status` (integer)

  - `failed.error.detail` (string)

  - `failed.error.instance` (string)

  - `successful` (array)

  - `successful.id` (string)
    The id of the schedule

  - `successful.searchId` (string)
    The id of the search that was being scheduled

  - `successful.isEmailRequired` (boolean)
    Indicates whether the schedule requires an email to be sent when the search is run

  - `successful.emailRecipients` (array)
    The email recipients that the email should be sent to when the search is run

  - `successful.createdById` (integer)
    The id of the user who created the schedule

  - `successful.createdAt` (string)
    The time the schedule was created

  - `successful.createdBy` (string)
    The name of the user who created the schedule

  - `successful.modifiedById` (integer)
    The id of the user who last modified the schedule

  - `successful.modifiedAt` (string)
    The time the schedule was last modified

  - `successful.modifiedBy` (string)
    The name of the user who last modified the schedule

  - `successful.type` (string)
    The type of the schedule, i.e. business or individual

  - `successful.name` (string)
    The name used in the search criteria

  - `successful.firstName` (string)
    The first name used in the search criteria

  - `successful.middleName` (string)
    The middle name used in the search criteria

  - `successful.lastName` (string)
    The last name used in the search criteria

  - `successful.gender` (string)
    The gender used in the search criteria, i.e. male or female

  - `successful.dateOfBirth` (string)
    The date of birth used in the search criteria

  - `successful.countries` (array)
    The list of country codes used in the search criteria

  - `successful.threshold` (integer)
    The threshold used in the search criteria

  - `successful.datasets` (array)
    The datasets used in the search criteria

  - `successful.pepTiers` (array)
    The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3

  - `successful.isDobRequired` (boolean,null)
    Indicates whether date of birth is required for the individual search.

  - `correlationId` (string)
    A unique ID assigned to this request.

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"