Register a custom-attribute definition

Search Documentation

Search across all developer documentation

attributes

Register a custom-attribute definition

POST /v1/attributes
Auth required api.attributes.manage

Registers a new managed attribute definition — the typed schema a Segment's SendQL predicate can then reference as attr.<name>. enum_values is required when type is enum and rejected otherwise. An invalid name or type returns 422 validation_failed.

Request body

Content type: application/json

{
  "name": "string",
  "type": "string",
  "enum_values": [
    "string"
  ],
  "description": "string",
  "formula": "string"
}

Responses

201 The created attribute 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