activity-properties
Preview an activity-property edit's impact
POST /v1/activity-properties/{id}/preview
Auth required
api.activities.manage
Dry-runs a proposed edit and returns its mutation_class and projected impact
— the segments that reference the property and, for a disruptive edit, each one's
typecheck outcome — without writing anything. The body is the proposed
definition (same shape as the PUT edit body). Use it before committing a
disruptive change. Git-backed definitions are read-only and return 409 conflict.
Path parameters
id string<uuid> required Resource UUID. An unparseable id reads as a clean 404 not_found.
Request body
Content type: application/json
{
"type": "string",
"enum_values": [
"string"
],
"description": "string"
}Responses
200 The projected mutation class and impact (no writes) application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
409 The mutation is rejected by a state rule rather than a bad request — e.g.
editing a git-backed (read-only) definition. The
code is conflict.
application/problem+json 422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json