Update Scheduled Action

PATCH 
https://sailpoint.api.identitynow.com/v2025/configuration-hub/scheduled-actions/:id

This API updates an existing scheduled action using JSON Patch format.

Request

Path Parameters

scheduledActionId stringrequired
The ID of the scheduled action.
Example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde

application/json-patch+json

Bodyrequired

The JSON Patch document containing the changes to apply to the scheduled action.

operations object[]
Operations to be applied
Array [
opstringrequired
The operation to be performed
Possible values: [add, remove, replace, move, copy, test]
Example: replace
pathstringrequired
A string JSON Pointer representing the target path to an element to be affected by the operation
Example: /description
value object
The value to be used for the operation, required for "add" and "replace" operations
oneOf
string
string
Example: New description
boolean
boolean
Example: true
integer
integer
Example: 300
object
object
Example: {"attributes":{"name":"philip"}}
array
Array [
anyOf
MOD1
string
MOD2
integer
MOD3
object
]
]

Responses

200

The updated scheduled action.

application/json

Schema

Schema

idstring
Unique identifier for this scheduled action.
Example: 3469b87d-48ca-439a-868f-2160001da8c1
createddate-time
The time when this scheduled action was created.
Example: 2021-05-11T22:23:16.000Z
jobTypestring
Type of the scheduled job.
Possible values: [BACKUP, CREATE_DRAFT, CONFIG_DEPLOY_DRAFT]
Example: BACKUP
content object
Content details for the scheduled action.
namestring
Name of the scheduled action (maximum 50 characters).
Possible values: <= 50 characters
Example: Daily Backup
backupOptions object
Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only.
includeTypesstring[]
Object types that are to be included in the backup.
Example: ["ROLE","IDENTITY_PROFILE"]
objectOptions object
Map of objectType string to the options to be passed to the target service for that objectType.
property name* object
includedNamesstring[]
Set of names to be included.
Example: ["Admin Role","User Role"]
sourceBackupIdstring
ID of the source backup. Required for CREATE_DRAFT jobs only.
Example: 5678b87d-48ca-439a-868f-2160001da8c2
sourceTenantstring
Source tenant identifier. Required for CREATE_DRAFT jobs only.
Example: tenant-name
draftIdstring
ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only.
Example: 9012b87d-48ca-439a-868f-2160001da8c3
startTimedate-time
The time when this scheduled action should start.
Example: 2021-05-12T10:00:00.000Z
cronStringstring
Cron expression defining the schedule for this action.
Example: 0 0 12 * * ?
timeZoneIdstring
Time zone ID for interpreting the cron expression.
Example: America/Chicago

Example (auto)

{
  "id": "3469b87d-48ca-439a-868f-2160001da8c1",
  "created": "2021-05-11T22:23:16.000Z",
  "jobType": "BACKUP",
  "content": {
    "name": "Daily Backup",
    "backupOptions": {
      "includeTypes": [
        "ROLE",
        "IDENTITY_PROFILE"
      ],
      "objectOptions": {
        "SOURCE": {
          "includedNames": [
            "Source1",
            "Source2"
          ]
        },
        "ROLE": {
          "includedNames": [
            "Admin Role",
            "User Role"
          ]
        }
      }
    },
    "sourceBackupId": "5678b87d-48ca-439a-868f-2160001da8c2",
    "sourceTenant": "tenant-name",
    "draftId": "9012b87d-48ca-439a-868f-2160001da8c3"
  },
  "startTime": "2021-05-12T10:00:00.000Z",
  "cronString": "0 0 12 * * ?",
  "timeZoneId": "America/Chicago"
}

Example

{
  "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
  "created": "2024-08-16T14:16:58.389Z",
  "jobType": "BACKUP",
  "content": {
    "name": "Updated Backup Name",
    "backupOptions": {
      "includeTypes": [
        "SOURCE",
        "IDENTITY"
      ],
      "objectOptions": {
        "SOURCE": {
          "includedNames": [
            "Source1",
            "Source2"
          ]
        }
      }
    }
  },
  "startTime": "2024-08-16T14:16:58.389Z",
  "cronString": "0 0 9 * * ?"
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error
A message describing the error
Example: JWT validation failed: JWT is expired

Example (auto)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message
A message describing the error
Example: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Authorization: oauth2

type: Personal Access Token
scopes: sp:config-scheduled-action:manage
user levels: ORG_ADMIN

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://sailpoint.api.identitynow.com/v2025/configuration-hub/scheduled-actions/:id"
  method := "PATCH"

  payload := strings.NewReader(`{
  "operations": [
    {
      "op": "replace",
      "path": "/description",
      "value": "New description"
    }
  ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json-patch+json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/v2025

Auth

Bearer Token

Parameters

scheduledActionId — pathrequired

Body required

• Example (from schema)
• Example

{
  "operations": [
    {
      "op": "replace",
      "path": "/description",
      "value": "New description"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!