Update Email Status

POST /rest/asset/v2/email/state/transition

Performs a state transition on an email.

Operation ID: stateTransitionUsingPOST_email
Permissions: Read-Write Assets, Access Design Studio, Approve Email
Request format: application/json
Returns: EmailNewResponse, ErrorResponse

Parameters

Query 1

access_token string required

Token for Authorization

The Request Builder sends the token in the Authorization header instead, so it never appears in URLs.

Header 1

x-app-type string required

Application type header

Values marketo

Request body

application/json · required · StateTransitionRequest · 2 properties

contentId string required

action string required

The state transition action to perform on the asset

Values approve unapprove discard create_draft

Responses

200 OK EmailNewResponse

success boolean

requestId string

result array of EmailDetailDTO

Model EmailDetailDTO

id string

name string

description string

appType string

headers EmailHeadersDTO

Model EmailHeadersDTO

ccEmails array of string

fromEmail string

fromName string

preheader string

replyEmail string

subject string required

metadata ContentMetadataDTO

Model ContentMetadataDTO

createdBy string

createdAt string

createdById string

createdByAepId string

modifiedBy string

modifiedAt string

modifiedById string

modifiedByAepId string

settings EmailSettingsResponseDTO

Model EmailSettingsResponseDTO

isOperational boolean

isWebPageView boolean

isTextOnly boolean

disableOpenTracking boolean

enableUrlTracking boolean

status string

state string

virtualId string

associatedStates array of AssociatedStateDTO

Model AssociatedStateDTO

contentId string

externalId string

state string

appData EmailAppDataResponseDTO

Model EmailAppDataResponseDTO

editorType string

workspaceId string

folderId string

programId string

programName string

programType string

templateId string

externalId string

editorContext EditorContextDto

Model EditorContextDto

dynamicContent object

scriptEngine string

data DataDTO

Model DataDTO

html HtmlDataDTO

Model HtmlDataDTO

result › data › html

body string

text TextDataDTO

Model TextDataDTO

result › data › text

body string

syncFromHtml boolean

Generated example

{
  "success": true,
  "requestId": "123",
  "result": [
    {
      "id": "123",
      "name": "Example name",
      "description": "string",
      "appType": "string",
      "headers": {
        "ccEmails": [
          "person@example.com"
        ],
        "fromEmail": "person@example.com",
        "fromName": "Example name",
        "preheader": "string",
        "replyEmail": "person@example.com",
        "subject": "string"
      },
      "metadata": {
        "createdBy": "string",
        "createdAt": "string",
        "createdById": "123",
        "createdByAepId": "123",
        "modifiedBy": "string",
        "modifiedAt": "string",
        "modifiedById": "123",
        "modifiedByAepId": "123"
      },
      "settings": {
        "isOperational": true,
        "isWebPageView": true,
        "isTextOnly": true,
        "disableOpenTracking": true,
        "enableUrlTracking": true
      },
      "status": "string",
      "state": "string",
      "virtualId": "123",
      "associatedStates": [
        {
          "contentId": "123",
          "externalId": "123",
          "state": "string"
        }
      ],
      "appData": {
        "editorType": "string",
        "workspaceId": "123",
        "folderId": "123",
        "programId": "123",
        "programName": "Example name",
        "programType": "string"
      },
      "templateId": "123",
      "externalId": "123",
      "editorContext": {
        "dynamicContent": {}
      },
      "scriptEngine": "string",
      "data": {
        "html": {
          "body": "string"
        },
        "text": {
          "body": "string",
          "syncFromHtml": true
        }
      }
    }
  ]
}

Default Error ErrorResponse

success boolean

requestId string

errors array of ContentWaveErrorDTO

Model ContentWaveErrorDTO

key string

message string

code string

dynamicMessage string

type string

Severity of the entry: info, warning, or error.

source string

Origin of the entry, e.g. validation, template, fragment, message_render, asset_publish.

errorMessage string

errorPosition object

Location in the content the entry refers to (for script/validation errors).

Generated example

{
  "success": true,
  "requestId": "123",
  "errors": [
    {
      "key": "string",
      "message": "string",
      "code": "string",
      "dynamicMessage": "string",
      "type": "string",
      "source": "string",
      "errorMessage": "string",
      "errorPosition": {
        "line": 123,
        "column": 123
      }
    }
  ]
}

Referenced models

Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.