activity-properties
Promote a custom-activity property
POST /v1/activity-properties
Auth required
api.activities.manage
Promotes a custom-activity property into the evaluable registry — registering
(activity_name, property_name) → type so a Segment's SendQL predicate can
reference it as activity.<activity>.<property>. enum_values is required when
type is enum and rejected otherwise. An invalid name or type, or exceeding
the per-activity promoted-property cap, returns 422 validation_failed.
Request body
Content type: application/json
{
"activity_name": "string",
"property_name": "string",
"type": "string",
"enum_values": [
"string"
],
"description": "string"
}Responses
201 The promoted activity-property definition 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
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