Schedule event deletions and blocks

이 페이지는 아직 귀하의 언어로 번역되지 않았습니다. 현재 작업 중이므로 곧 다시 확인해 주십시오.

Each event_type must already exist on the project and may appear only once
in items. Update and cancel take scheduled-action ids, so they do not look
up the event again.
One pending scheduled action is allowed per event type. If that event
already has a pending deletion or block, cancel it before creating another.
The whole request fails if any item cannot be created.

post/v1/projects/{project_id}/scheduled-event-actions

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

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

Header parameters

Idempotency-Keystringrequired

Required on write operations. Keys aren't stored yet, so retrying a write with the same key performs it again; a retried create makes another resource. Check whether the first attempt succeeded before you retry.

Constraints:min length: 8max length: 255

Body

application/json
itemsobject[]required
Show child attributes
event_typestringrequired
Constraints:min length: 1
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
days_from_nowintegerrequired

Days until the action runs. The server computes target_date.

Constraints:min: 1

Response

application/json
201· Scheduled actions created.
dataobject[]required
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.

이 내용이 도움이 되었나요?

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.