Skip to content

Update Email Status

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

Permissions Read-Write AssetsAccess Design StudioApprove Email

Build a request and mock the response

Method: POST
Path: /rest/asset/v2/email/state/transition
Tag: Emails (New)
Operation ID: stateTransitionUsingPOST_email

Performs a state transition on an email. Required Permissions: Read-Write Assets, Access Design Studio, Approve Email.

Formats

  • Request: application/json
  • Response: application/json

Request

Query parameters

Name Type Required Description Constraints
access_token string Yes Token for Authorization

Header parameters

Name Type Required Description Constraints
x-app-type string Yes Application type header enum: marketo

Request body

Name: stateTransitionRequest
Required: Yes
Schema: model: StateTransitionRequest

stateTransitionRequest

Generated example

{
  "contentId": "123",
  "action": "approve"
}

Referenced models

Example request

POST {{base_url}}/rest/asset/v2/email/state/transition?access_token={{access_token}}
x-app-type: marketo
Content-Type: application/json
Accept: application/json

{
  "contentId": "123",
  "action": "approve"
}

Responses

200 — OK

Schema: model: EmailNewResponse

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
        }
      }
    }
  ]
}

Referenced models

default — Error

Schema: model: ErrorResponse

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

Source

Generated from swagger-asset.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.