Get a scheduled event deletion or block

get/v1/projects/{project_id}/scheduled-event-actions/{scheduled_event_action_id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$
scheduled_event_action_idstringrequired

Scheduled event action identifier.

Constraints:min length: 1

Response

application/json
200· Successful response.
dataobjectrequired
Show child attributes
idstringrequired

Stable scheduled-action identifier.

objectstringrequired

Resource-type discriminator. Always scheduled_event_action.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
event_typestringrequired
display_namestringrequired

Event display name when known; otherwise equal to event_type.

actionstringrequired

Work to apply when target_date arrives. delete removes the event from the tracking plan (soft-delete if ingested). block stops ingestion.

Allowed values:deleteblock
target_datestringrequired
Constraints:format: date-time
statusstringrequired

Lifecycle of a scheduled event action. List defaults to pending.

Allowed values:pendingcanceledcompleted
created_atstringrequired

When the action was scheduled.

Constraints:format: date-time
created_bystringrequired

Login id of the user who scheduled the action.

Was this helpful?

For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.