API Reference

Create Published Attribute

post
https://sandbox.alloy.co/v1/published-attributes
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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.
string
enum
required

The data type of the published attribute.

Allowed:
required

A default value is assigned to the published attribute for each object of the object_type. If the published attribute is being used as an input attribute, then this value will be used if there is no value provided in the evaluation payload.

string | null

A description of the default value.

boolean
required

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.

string
enum
required

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
Allowed:
integer | null

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

string | null

A way to transform JSON using the jq cli tool.

string | null

A description of the published attribute.

Responses

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago