Update action set action

Request

PUT /v3/action-sets/{actionSetId}/actions/{actionId}

Update a specific action in an action set

Security

API_Key

Path

actionSetIdinteger, (int64)required

ID of the action set

actionIdinteger, (int64)required

ID of the action to update

Bodyapplication/jsonrequired

sequenceintegerrequired

Sequence number of the action

descriptionstring

Description of the action. Present for all actionTypes except: actionSet

actionTypestringrequired

Type of the user action

Enum:"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"

waitDurationinteger

Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut

selectorsArray of objects

List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame

preventNavigationboolean

Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput

valuestring

Value field with different meanings per actionType. For input/select: input value. For navTo: URL. For privacyOptIn/privacyOptOut: URL. For execute: JavaScript code. Present for actionTypes: input, select, navTo, privacyOptIn, privacyOptOut, execute

maskedValuestring

Masked value for secure input actions. Present for actionType: maskedInput

jsstring

JavaScript code to execute. Present for actionType: execute

urlstring

URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut

secondsinteger

Number of seconds to watch/wait. Present for actionType: watch

isRequiredboolean

Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut

actionSetIdinteger, (int64)

ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID

pageFilterstring

Page filter pattern for the action

PUT

/v3/action-sets/{actionSetId}/actions/{actionId}

curl -i -X PUT \
  'https://api.observepoint.com/v3/action-sets/{actionSetId}/actions/{actionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sequence": 0,
    "description": "string",
    "actionType": "click",
    "waitDuration": 0,
    "selectors": [
      {
        "selectorType": "id",
        "value": null
      }
    ],
    "preventNavigation": true,
    "value": "string",
    "maskedValue": "string",
    "js": "string",
    "url": "string",
    "seconds": 0,
    "isRequired": true,
    "actionSetId": 0,
    "pageFilter": "string"
  }'

Responses

Action updated successfully

Bodyapplication/json