ALalloy
Published Attributes

Create Published Attribute

post/published-attributes

Request

Request body

published_attribute_tokenstring

An Alloy system generated unique ID for the published attribute.

published_attribute_namestring

The name of the published attribute.

  • If the published attribute is an input attribute in a workflow, this name will serve as the selector in the Evaluation payload.
  • When creating transactions via the Events API (transaction events), you can include published attribute values directly in the event data payload using this name as the field name.
data_type'integer' | 'decimal' | 'string' | 'boolean' | 'date' | 'timestamp'

The data type of the published attribute.

default_value_notestring nullable

A description of the default value.

contains_piiboolean

This is set to true when the published attribute contains PII. If it's true this field will be stored encrypted. Unable to be changed once set.

object_type'entity' | 'transaction'

The object type to which this published attribute applies.

  • entity: Published attribute values are associated with entities and require either entity_token or external_entity_id
  • transaction: Published attribute values are associated with transactions and require a transaction_token
value_expires_ininteger nullable

The number of seconds that this published attribute's values will persist for.

jq_filterstring nullable

A way to transform JSON using the jq cli tool.

descriptionstring nullable

A description of the published attribute.

Response

Published Attribute Object.

published_attribute_tokenstring

An Alloy system generated unique ID for the published attribute.

messagestring

A message indicating that the published attribute was created.

Example response

{
  "published_attribute_token": "PA-54eKJIaGGzXdJcyBgrqK",
  "message": "published attribute has been created"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.