Fetch a computed trait definition
Beta
Twilio Cohorts is currently available as a Private Beta product and the information contained in this document is subject to change. You acknowledge and agree that your use of Twilio Cohorts is subject to the terms of the Services in Private Beta. This means that some features are not yet implemented and others may be changed before the product is declared as Generally Available. Private Beta products are not covered by the Twilio Support Terms or Twilio Service Level Agreement.
Not a HIPAA Eligible Service or PCI Compliant
Twilio Cohorts is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.
GET/preview/ComputedTraitDefinitions/{computedTraitDefinitionId}
Base url: https://audiences.twilio.com (base url)
Used to read parameterSchema before instantiating, so a caller knows
which parameters are overridable, within what bounds, and their defaults.
The computedTraitDefinitionId identifier
OK - The computed trait definition
Optional
Identifier of a Twilio-authored computed trait definition: a human-readable slug, stable across environments.
twilio.frequency_capPattern: ^twilio\.[a-z0-9_]+$Max length: 128Optional
Human-readable name of the definition
Frequency capMax length: 128Optional
What the definition computes
Whether the profile has reached its marketing send cap within the window.Max length: 1024Optional
Tags for organizing and categorizing resources as key-value pairs.
- Maximum of 10 key-value pairs
- Maximum size of a tag key is 128 characters
- Maximum size of a tag value is 256 characters
- Keys and values must be non-empty and URL-safe: only unreserved characters
(
A-Z,a-z,0-9,-,.,_,~) are allowed. Tags are echoed back in thetagsquery parameter of the list endpoints, so anything you can store here can also be filtered on. - Keys cannot use the reserved
twilio__prefix
{"environment":"production","campaign":"q1-2026"}Max properties: 10Optional
Fully qualified trait key, TraitGroup.traitName. Its format is checked
against the store's trait schema rather than a local pattern, so it follows
whatever names the store allows.
SendIntelligence.weeklyCapMax length: 256Optional
Type of the value written to the trait. Must match the trait key's type in the store schema.
NUMBERPossible values: STRINGINTEGERNUMBERBOOLEANOptional
The parameters a computed trait may override, each with its type,
bounds, and defaultValue
321curl -X GET "https://audiences.twilio.com/preview/ComputedTraitDefinitions/computedTraitDefinitionId" \2-u $TWILIO_API_KEY:$TWILIO_API_SECRET
Response
1{2"id": "twilio.frequency_cap",3"displayName": "Frequency cap",4"description": "Whether the profile has reached its marketing send cap within the window.",5"tags": {},6"traitKey": "SendIntelligence.frequencyCapped",7"valueType": "BOOLEAN",8"parameterSchema": [9{10"slug": "windowDays",11"description": "Rolling window the sends are counted over, in days",12"dataType": "NUMBER",13"validationRule": {14"ruleType": "NUMBER",15"min": 1,16"max": 36517},18"required": false,19"defaultValue": 720},21{22"slug": "maxSends",23"description": "Sends allowed within the window",24"dataType": "NUMBER",25"validationRule": {26"ruleType": "NUMBER",27"min": 1,28"max": 10029},30"required": false,31"defaultValue": 532}33]34}