GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Update Variable

put
https://api.seismic.com/variable/v1/variables/

Update a variable object.

Variable types

Different types of Variable put different parameter values, please fill in the parameters as described below:

  • Custom
    • contentFormat: Variable text
    • valueDefinition: Use the CustomVariableValueDefinition data model
    • formatDefinition: VariableFormatDefinition is required
  • UserProfile
    • contentFormat: Variable text
    • valueDefinition: Use the UserProfileVariableValueDefinition data model
  • CRM
    • contentFormat: Variable text
    • valueDefinition: Use the CRMVariableValueDefinition data model
  • UserHeadshot
    • contentFormat: Variable image
    • valueDefinition: Use the UserHeadshotVariableValueDefinition data model
  • FixedImage
    • contentFormat: Variable image
    • valueDefinition: Use the FixedImageVariableValueDefinition data model

Versioning

Each call to this endpoint creates a new version of the variable rather than mutating a single record in place. The most recently created version becomes the latest version; it must be explicitly promoted before it is returned by default from Get Variable Definition, Get All Variable Definitions, or evaluation calls.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the variable to update.

Query Params
string
required
length ≥ 1

The identifier of the teamsite that owns the variable. Usually a GUID, but may be a plain identifier such as "1" for the default teamsite on some older tenants.

Body Params

The updated variable definition. This creates a new version of the variable rather than mutating the existing one in place.

string
required

A unique, human-readable name for the variable, used to reference it in Get Variable Value(s) calls.

string
enum
required

The source of the variable's value. Determines which valueDefinition shape is required — see the discriminator mapping below.

Allowed:
string
enum
required

Whether this variable resolves to plain text or to an image asset. The value supplied here has no effect — the server always derives contentFormat itself from the sibling type field (Variable text for Custom/UserProfile/CRM; Variable image for UserHeadshot/FixedImage) and ignores whatever is sent. Documented for forward compatibility with the response shape, which always reflects the derived value.

Allowed:
string
enum
required

The primitive data type the variable's resolved value should be treated as. For UserHeadshot and FixedImage variables, the value supplied here is ignored — the server always forces outputType to Blob for these two types.

Allowed:
valueDefinition
required

The type-specific configuration that determines where this variable's value comes from. Must match the sibling type field.

formatDefinition
object

Controls how a variable's raw value is rendered as display text — decimal precision, thousands separators, currency/unit symbols, and number/date sub-formats.

string

The human-readable display name shown to content authors when selecting this variable. Custom variables only.

string

Guidance text shown to content authors explaining how to fill in this variable. Custom variables only.

string
enum

The input control shown to content authors when providing a value for this variable. Custom variables only.

Allowed:
boolean

Whether content authors are prevented from overriding this variable's value once it is set. Custom variables only.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?