openapi: 3.2.0
info:
  version: 1.0.0
  title: Customer.io App Design Studio API
  description: 'Our App API provides ways to trigger messages and retrieve information about people, campaigns, broadcasts, and more.


    # Overview


    The App API provides methods to send newsletters, transactional messages, and API-triggered broadcasts. You can create newsletters from scratch and update transactional messages and API-triggered broadcasts.


    For transactional messages and API-triggered broadcasts, your payload acts as a message "trigger" and can contain `data` that you reference in your messages using liquid—`{{trigger.<data>}}`.


    The other endpoints help you retrieve information about people, segments, campaigns, broadcasts, etc; it also lets you update campaign actions, messages, newsletter variants, etc. Aside from the [API-triggered broadcast](#triggerBroadcast) (1 per 10 seconds) and [Transactional](#sendEmail) (100 per second) endpoints, requests are limited to 10 per second.


    # Use our Postman collection


    We''ve generated a Postman collection to help you get started with our APIs.


    If you fork this collection, you might want to disable the *Watch original collection* option. We automatically update our Postman collection whenever we release changes to our documentation, even if we don''t change our APIs—which happens daily! Rather than being flooded with Postman notifications, you can check out our [Release Notes](/release-notes/) for updates to our APIs.


    **NOTE**: Postman endpoints default to our US APIs. If you''re in our European (EU) region, you''ll need to add `-eu` to the server variables (`track_api_url` and `app_api_url`).


    [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/23697545-2931c004-e63d-4cdc-bf4b-e685ba6da42d?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D23697545-2931c004-e63d-4cdc-bf4b-e685ba6da42d%26entityType%3Dcollection%26workspaceId%3Db886877f-fc09-475f-84fe-6221a98f4d18#?env%5BCustomer.io%20API%20Environment%5D=W3sia2V5IjoidHJhY2tfYXBpX3VybCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiJ0cmFjay5jdXN0b21lci5pbyIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYXBwX2FwaV91cmwiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiYXBpLmN1c3RvbWVyLmlvIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzaXRlX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYXBpX2tleSIsInR5cGUiOiJzZWNyZXQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYmVhcmVyIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYnJvYWRjYXN0X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaW1wb3J0X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiZW1haWxfYWRkcmVzcyIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InN1cHByZXNzaW9uX3R5cGUiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb2xsZWN0aW9uX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoic25pcHBldF9uYW1lIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoid2ViaG9va19pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InNlbmRlcl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImV4cG9ydF9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6Im1lc3NhZ2VfaWQiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzZWdtZW50X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoibmV3c2xldHRlcl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNvbnRlbnRfaWQiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjYW1wYWlnbl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImFjdGlvbl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImN1c3RvbWVyX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidHJhbnNhY3Rpb25hbF9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InRyaWdnZXJfaWQiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJmb3JtX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaWRlbnRpZmllciIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImRldmljZV9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImRlbGl2ZXJ5X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9XQ==)


    # Server addresses: US and EU


    Customer.io hosts services in the United States (US) and European Union. Select the appropriate server address for your region.


    | Region | Server Address |

    | :-- | :-- |

    | US | https://api.customer.io |

    | EU | https://api-eu.customer.io |


    # Authentication


    All requests to the Customer.io App API use an [App API Key](#App-API-Key).


    To authenticate, provide your key as a Bearer token in a HTTP Authorization header. You can create and manage your API keys—including keys with different scopes—in [your account settings page](https://fly.customer.io/settings/api_credentials?keyType=app). Each operation on this page references the authorization header it requires.


    # Rate Limits


    Most endpoints on this page are limited to 10 requests per second. The exceptions are:

    * The [transactional email](#operation/sendEmail) endpoint is limited to 100 requests per second.

    * The [API-triggered broadcast endpoint](#operation/triggerBroadcast) is limited to 1 request every 10 seconds.


    **Rate limits are subject to change. We may adjust these thresholds to ensure stable performance for all customers.**

    '
servers:
- url: https://api.customer.io
  description: The base URL for broadcasts, transactional messages, and data-retrieval APIs. These endpoints use bearer authorization, and require a [token that you generate in the UI](https://fly.customer.io/settings/api_credentials?keyType=app).
- url: https://api-eu.customer.io
  description: The base URL for broadcasts, transactional messages, and data-retrieval APIs (EU region). These endpoints use bearer authorization, and require a [token that you generate in the UI](https://fly.customer.io/settings/api_credentials?keyType=app).
tags:
- name: Design Studio
  description: 'Use these endpoints to manage emails, translations, and components made with Design Studio. You can programmatically manage Design Studio content and migrate templates from an external service. To manage assets like images, use the [Assets API](/integrations/api/app/#tag/assets).


    These endpoints do not enable you to publish changes to connected workflows like campaigns, nor can you update global styles. They''re only for content management at this time. Learn more about the [best practices](/integrations/api/integrate-with-ds/) for sending HTML through these endpoints.


    If you''re an external tool and interested in being listed as one of our integrated partners, please reach out to [product@customer.io](mailto:product@customer.io) to chat with a Product Manager!

    '
paths:
  /v1/design_studio/folders:
    get:
      tags:
      - Design Studio
      summary: List folders
      operationId: listFolders
      description: 'Returns a paginated list of folders. This does not include files like emails, components, etc.

        '
      parameters:
      - name: page
        in: query
        description: The page number of results you want to display. Use with `limit`.
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: limit
        in: query
        description: Limit the number of results per page.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
          default: 1000
      - name: parent_folder_id
        in: query
        schema:
          type: string
          format: uuid
        description: 'Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.


          To list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`.

          '
      - name: direct_descendants_only
        in: query
        description: If true, this returns only children of the parent folder.
        schema:
          type: boolean
          default: false
      - name: sort_by
        in: query
        schema:
          type: string
          enum:
          - created
          - updated
          - name
          default: created
      - name: sort_order
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: created_before
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records created before this time. Must be a unix timestamp.
        example: 1773856017
      - name: created_after
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records created after this time. Must be a unix timestamp.
        example: 1773856017
      - name: updated_before
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records updated before this time. Must be a unix timestamp.
        example: 1773856017
      - name: updated_after
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records updated after this time. Must be a unix timestamp.
        example: 1773856017
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  folders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID of folder
                        name:
                          type: string
                          description: The name of the folder.
                        parent_folder_id:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: The ID of the parent folder. Returns `null` if there is no parent, which means the folder is in the root directory.
                        created:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of when the folder was created.
                        updated:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of last update to the folder.
                      example:
                        id: 123e4567-e89b-12d3-a456-426614174000
                        name: Product Announcements
                        parent_folder_id: null
                        created: 1714732800
                        updated: 1714732800
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                            description: The page number of results you're on.
                          limit:
                            type: integer
                            description: The number of results per page.
                          total:
                            type: integer
                            description: The total number of folders.
                      filters:
                        type: object
                        description: The filters applied in your request.
                        example:
                          parent_folder_id: 123e4567-e89b-12d3-a456-426614174000
                          direct_descendants_only: true
                          sort_by: created
                          sort_order: desc
                          created_before: 1714732800
                          created_after: null
                          updated_before: null
                          updated_after: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: invalid query parameter
                  status: 400
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url 'https://api.customer.io/v1/design_studio/folders?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/folders?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/folders?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/folders?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/folders?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    post:
      tags:
      - Design Studio
      summary: Create a folder
      description: 'Create a new folder at the root level or under a parent folder. To create a child folder, you need the UUID of the parent folder, which you can retrieve with [List folders](#tag/design-studio/listFolders).

        '
      operationId: createFolder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: 'The name of the folder. Cannot contain these characters: < > : " / \ | ? * .

                    '
                  minLength: 1
                  maxLength: 170
                  example: Product Announcements
                parent_folder_id:
                  type:
                  - string
                  - 'null'
                  description: UUID of the parent folder. Omit or pass `null` to create at root.
                  format: uuid
      responses:
        '200':
          description: Folder created
          content:
            application/json:
              schema:
                type: object
                properties:
                  folder:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: ID of folder
                      name:
                        type: string
                        description: The name of the folder.
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: The ID of the parent folder. Returns `null` if there is no parent, which means the folder is in the root directory.
                      created:
                        type: integer
                        format: Unix timestamp
                        description: Timestamp of when the folder was created.
                      updated:
                        type: integer
                        format: Unix timestamp
                        description: Timestamp of last update to the folder.
                    example:
                      id: 123e4567-e89b-12d3-a456-426614174000
                      name: Product Announcements
                      parent_folder_id: null
                      created: 1714732800
                      updated: 1714732800
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        detail:
                          description: The name is missing or invalid, the parent folder id is an empty string, or there's an unknown JSON field in the request body
                          type: string
                        status:
                          description: Response code
                          type: integer
                example:
                  errors:
                  - detail: missing or invalid name
                    status: 400
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Response not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: parent folder not found
                  status: 404
      x-codeSamples:
      - lang: json
        label: JSON
        source: "{\n  \"name\": \"Product Announcements\"\n}"
      - lang: Shell + Curl
        source: "curl --request POST \\\n  --url https://api.customer.io/v1/design_studio/folders \\\n  --header 'content-type: application/json' \\\n  --data '{\"name\":\"Product Announcements\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\"}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"POST\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/folders\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  name: 'Product Announcements',\n  parent_folder_id: '26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec'\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/folders")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Post.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"name\":\"Product Announcements\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\"}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"name\":\"Product Announcements\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\"}"


          headers = { ''content-type'': "application/json" }


          conn.request("POST", "/v1/design_studio/folders", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/folders\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"Product Announcements\\\",\\\"parent_folder_id\\\":\\\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/folders/{id}:
    get:
      tags:
      - Design Studio
      summary: Get a folder
      description: 'Get a folder by its UUID. You can retrieve the UUID of folders through [List folders](#tag/design-studio/listFolders).

        '
      operationId: getFolder
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the folder.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  folder:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: ID of folder
                      name:
                        type: string
                        description: The name of the folder.
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: The ID of the parent folder. Returns `null` if there is no parent, which means the folder is in the root directory.
                      created:
                        type: integer
                        format: Unix timestamp
                        description: Timestamp of when the folder was created.
                      updated:
                        type: integer
                        format: Unix timestamp
                        description: Timestamp of last update to the folder.
                    example:
                      id: 123e4567-e89b-12d3-a456-426614174000
                      name: Product Announcements
                      parent_folder_id: null
                      created: 1714732800
                      updated: 1714732800
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.customer.io/v1/design_studio/folders/{id}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/folders/%7Bid%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/folders/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/folders/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/folders/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    put:
      tags:
      - Design Studio
      summary: Update a folder
      description: 'Update part of a folder: the name and/or the folder it belongs to. If you move a folder, all files stay nested in the folder.

        '
      operationId: updateFolder
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the folder.
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Name of the folder. Cannot contain any of these characters: < > : " / \ | ? * .

                    '
                  minLength: 1
                  maxLength: 170
                parent_folder_id:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  description: 'The UUID of the parent folder.


                    Omit if you want no change to where the folder or file is located. Include `null` to move it to your root directory. Or add the UUID of another folder to move it there.

                    '
      responses:
        '204':
          description: Successful response, no content returned
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        detail:
                          description: 'Possible reasons for error: No fields provided, invalid name, parent_folder_id is an empty string or not a valid place to move the folder to, or unknown JSON field in request body

                            '
                          type: string
                        status:
                          description: Response code
                          type: integer
                example:
                  errors:
                  - detail: missing or invalid name
                    status: 400
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: json
        label: JSON
        source: '{}'
      - lang: Shell + Curl
        source: "curl --request PUT \\\n  --url https://api.customer.io/v1/design_studio/folders/{id} \\\n  --header 'content-type: application/json' \\\n  --data '{\"name\":\"string\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\"}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"PUT\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/folders/%7Bid%7D\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({name: 'string', parent_folder_id: '26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec'}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/folders/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Put.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"name\":\"string\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\"}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"name\":\"string\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\"}"


          headers = { ''content-type'': "application/json" }


          conn.request("PUT", "/v1/design_studio/folders/%7Bid%7D", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/folders/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"parent_folder_id\\\":\\\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    delete:
      tags:
      - Design Studio
      summary: Delete a folder
      description: 'Delete a folder **including subfolders and all file (components, templates, and emails)**. You cannot delete a folder with emails used in your workflows (campaigns, broadcasts, etc).


        However, you can delete a folder with components that are referenced in emails connected to workflows, so make sure deleting a folder with components won''t break your emails.

        '
      operationId: deleteFolder
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the folder.
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successful response, no content returned
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
        '409':
          description: Conflict - linked resource or other constraint violation
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: a constraint violation prevents this operation
                  status: 409
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request DELETE \\\n  --url https://api.customer.io/v1/design_studio/folders/{id}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"DELETE\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/folders/%7Bid%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/folders/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Delete.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("DELETE", "/v1/design_studio/folders/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/folders/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/emails:
    get:
      tags:
      - Design Studio
      summary: List emails
      description: 'Returns a paginated list of emails and a separate array of folders that the emails belong to.

        '
      operationId: listEmails
      parameters:
      - name: page
        in: query
        description: The page number of results you want to display. Use with `limit`.
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: limit
        in: query
        description: Limit the number of results per page.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
          default: 1000
      - name: parent_folder_id
        in: query
        schema:
          type: string
          format: uuid
        description: 'Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.


          To list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`.

          '
      - name: direct_descendants_only
        in: query
        description: If true, this returns only children of the parent folder.
        schema:
          type: boolean
          default: false
      - name: sort_by
        in: query
        schema:
          type: string
          enum:
          - created
          - updated
          - name
          default: created
      - name: sort_order
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: created_before
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records created before this time. Must be a unix timestamp.
        example: 1773856017
      - name: created_after
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records created after this time. Must be a unix timestamp.
        example: 1773856017
      - name: updated_before
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records updated before this time. Must be a unix timestamp.
        example: 1773856017
      - name: updated_after
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records updated after this time. Must be a unix timestamp.
        example: 1773856017
      - name: is_template
        description: Filter by whether the email is a template
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
          - any
          default: any
      - name: has_translations
        description: Filter by whether the email has translations
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
          - any
          default: any
      - name: is_linked
        description: Filter by whether the email is linked to a workflow (campaign, broadcast, etc).
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
          - any
          default: any
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID of email
                          example: sdflkj345
                        name:
                          type: string
                          description: The name of the email
                        is_template:
                          type: boolean
                          description: Whether the email is a template
                        is_linked:
                          type: boolean
                          description: Whether the email is linked to a workflow (campaign, broadcast, etc)
                        has_translations:
                          type: boolean
                          description: Whether the email has translations
                        parent_folder_id:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: The ID of the parent folder. Returns `null` if there is no parent, which means the folder is in the root directory.
                          example: 123e4567-e89b-12d3-a456-426614174000
                        created:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of when the email was created.
                          example: 1714732800
                        updated:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of last update to the email.
                          example: 1714732800
                  folders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID of folder
                        name:
                          type: string
                          description: The name of the folder.
                        parent_folder_id:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: The ID of the parent folder. Returns `null` if there is no parent, which means the folder is in the root directory.
                        created:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of when the folder was created.
                        updated:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of last update to the folder.
                      example:
                        id: 123e4567-e89b-12d3-a456-426614174000
                        name: Product Announcements
                        parent_folder_id: null
                        created: 1714732800
                        updated: 1714732800
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                            description: The page number of results you're on.
                          limit:
                            type: integer
                            description: The number of results per page.
                          total:
                            type: integer
                            description: The total number of folders.
                      filters:
                        type: object
                        description: The filters applied in your request.
                        example:
                          parent_folder_id: 123e4567-e89b-12d3-a456-426614174000
                          direct_descendants_only: true
                          sort_by: created
                          sort_order: desc
                          created_before: 1714732800
                          created_after: null
                          updated_before: null
                          updated_after: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: invalid query parameter
                  status: 400
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url 'https://api.customer.io/v1/design_studio/emails?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE&is_template=SOME_STRING_VALUE&has_translations=SOME_STRING_VALUE&is_linked=SOME_STRING_VALUE'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE&is_template=SOME_STRING_VALUE&has_translations=SOME_STRING_VALUE&is_linked=SOME_STRING_VALUE\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE&is_template=SOME_STRING_VALUE&has_translations=SOME_STRING_VALUE&is_linked=SOME_STRING_VALUE")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/emails?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE&is_template=SOME_STRING_VALUE&has_translations=SOME_STRING_VALUE&is_linked=SOME_STRING_VALUE")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE&is_template=SOME_STRING_VALUE&has_translations=SOME_STRING_VALUE&is_linked=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    post:
      tags:
      - Design Studio
      summary: Create an email
      description: Create an email. Note, you can create an email without filling out all required fields for sending. You can fill in the envelope, like a to and from address, with this method, but that's not required until you connect it to a workflow like a campaign.
      operationId: createEmail
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Display name of the email.
                is_template:
                  type: boolean
                  default: false
                  description: Whether the email is a reusable template.
                parent_folder_id:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  description: UUID of the parent folder. Omit or pass `null` to create at root.
                content:
                  type: object
                  description: The content of your email.
                  properties:
                    subject:
                      type: string
                      description: Email subject line.
                    preheader_text:
                      type: string
                      description: Preview text.
                    html:
                      type: string
                      description: HTML body.
                    amp:
                      type: string
                      description: AMP HTML body.
                    text:
                      type: string
                      description: Plain text body.
                envelope:
                  type: object
                  description: The envelope of your email, like from and to addresses.
                  properties:
                    from_id:
                      type:
                      - integer
                      - 'null'
                      description: 'Sender identity ID. Must reference an existing identity. You can find this in *Workspace Settings > Email* under your From Addresses.

                        '
                    reply_to_id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                      description: 'Reply-to identity ID. Must reference an existing identity from *Workspace Settings > Email* under your From Addresses.

                        '
                    recipient:
                      type: string
                      description: 'Recipient email address. Defaults to `{{customer.email}}`` if not set.

                        '
                    bcc:
                      type: string
                      description: BCC email address.
                    fake_bcc:
                      type: boolean
                      description: Whether to use fake BCC. Defaults to true if not provided.
                    headers:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value:
                            type: string
                      description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                        '
                transformers:
                  type: object
                  description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                  properties:
                    url_parameters:
                      type: object
                      description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable URL parameter injection.

                            '
                          default: false
                        parameters:
                          type: array
                          description: 'List of parameters to append to URLs.

                            '
                          default: []
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: 'Parameter name.

                                  '
                              value:
                                type: string
                                description: 'Parameter value. May contain template variables.

                                  '
                              url_encode:
                                type: boolean
                                description: 'URL-encode the value before appending it to the URL.

                                  '
                    css_variables:
                      type: object
                      description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS variable resolution.

                            '
                          default: false
                        preserve:
                          type: boolean
                          description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                            '
                          default: false
                    css_inliner:
                      type: object
                      description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS inlining.

                            '
                          default: false
                        apply_style_tags:
                          type: boolean
                          description: 'Inline styles from `<style>` tags.

                            '
                          default: true
                        preserve_important:
                          type: boolean
                          description: 'Preserve `!important` declarations in inlined styles.

                            '
                          default: false
                        remove_style_tags:
                          type: boolean
                          description: 'Remove `<style>` tags after inlining their rules.

                            '
                          default: true
                        preserve_font_faces:
                          type: boolean
                          description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_media_queries:
                          type: boolean
                          description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_keyframes:
                          type: boolean
                          description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_pseudos:
                          type: boolean
                          description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                            '
                          default: true
                        inline_pseudo_elements:
                          type: boolean
                          description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                            '
                          default: false
                        apply_html_attributes:
                          type: object
                          description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                            '
                          properties:
                            enabled:
                              type: boolean
                              description: 'Enable adding redundant HTML attributes.

                                '
                              default: true
                            apply_width_attributes:
                              type: boolean
                              description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                '
                              default: true
                            apply_height_attributes:
                              type: boolean
                              description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                '
                              default: true
                            apply_table_element_attributes:
                              type: boolean
                              description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                '
                              default: true
                    accessibility:
                      type: object
                      description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable accessibility fixes.

                            '
                          default: false
                        language:
                          type: string
                          description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                            '
                          default: ''
                        add_lang_to_html:
                          type: boolean
                          description: 'Add `lang` attribute to the `<html>` element if not already present.

                            '
                          default: true
                        add_dir_to_html:
                          type: boolean
                          description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                            '
                          default: true
                        add_lang_to_content:
                          type: boolean
                          description: 'Add `lang` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_dir_to_content:
                          type: boolean
                          description: 'Add `dir` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_role_to_tables:
                          type: boolean
                          description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                            '
                          default: true
                        add_vml_alt_text:
                          type: boolean
                          description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                            '
                          default: true
                        add_empty_alt_to_images:
                          type: boolean
                          description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                            '
                          default: true
                        add_title_to_head:
                          type: boolean
                          description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                            '
                          default: true
                        remove_button_role_from_links:
                          type: boolean
                          description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                            '
                          default: true
                        remove_zoom_meta_tag:
                          type: boolean
                          description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                            '
                          default: true
                    formatter:
                      type: object
                      description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                        '
                      properties:
                        type:
                          type: string
                          description: 'Formatting mode to apply.

                            '
                          enum:
                          - none
                          - prettify
                          - minify
                          default: none
                        prettify:
                          type: object
                          description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                            '
                          properties:
                            indent_character:
                              type: string
                              description: 'Character used for indentation.

                                '
                              enum:
                              - spaces
                              - tabs
                              default: spaces
                            indent_size:
                              type: integer
                              description: 'Number of indent characters per level.

                                '
                              default: 2
                            wrap_attributes:
                              type: boolean
                              description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                '
                              default: false
                        minify:
                          type: object
                          description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                            '
                          properties:
                            remove_line_breaks:
                              type: boolean
                              description: 'Remove all line breaks from the output.

                                '
                              default: false
                            line_length_limit:
                              type: integer
                              description: 'Maximum characters per line before inserting a line break.

                                '
                              default: 500
                            remove_indentations:
                              type: boolean
                              description: 'Remove leading whitespace indentation.

                                '
                              default: true
                            remove_html_comments:
                              type: string
                              description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                '
                              enum:
                              - '0'
                              - '1'
                              - '2'
                              default: '0'
                            remove_css_comments:
                              type: boolean
                              description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                '
                              default: true
                    prevent_widows:
                      type: object
                      description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable widow word prevention.

                            '
                          default: false
                    encode_entities:
                      type: object
                      description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable HTML entity encoding.

                            '
                          default: false
                    remove_unused_css:
                      type: object
                      description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable unused CSS removal.

                            '
                          default: false
                        whitelist:
                          type: array
                          description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                          items:
                            type: string
                            description: 'A CSS selector to always keep.

                              '
                        backend_markers:
                          type: array
                          description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                            '
                          default:
                          - heads: ''
                            tails: ''
                          - heads: '{%'
                            tails: '%}'
                          items:
                            type: object
                            properties:
                              heads:
                                type: string
                                description: 'Opening delimiter.

                                  '
                              tails:
                                type: string
                                description: 'Closing delimiter.

                                  '
                        uglify:
                          type: boolean
                          description: 'Shorten (uglify) CSS class names to reduce file size.

                            '
                          default: false
      responses:
        '200':
          description: Email created
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the email.
                        example: sdflkj345
                      name:
                        type: string
                        description: Display name of the email.
                      is_template:
                        type: boolean
                        description: Whether the email is a reusable template.
                      is_linked:
                        type: boolean
                        description: 'Whether the email is currently linked to a workflow (campaign, broadcast, etc).

                          '
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: 'UUID of the parent folder, or `null` if the email is in your root directory.

                          '
                      available_languages:
                        type: array
                        items:
                          type: string
                        description: List of [language codes](/journeys/channels/localization/attribute/#supported-languages) that reflect the languages this default email has been translated to.
                        example:
                        - en
                        - es
                      created:
                        type: integer
                        format: int64
                        description: Unix timestamp of when the email was created.
                        example: 1773856017
                      updated:
                        type: integer
                        format: int64
                        description: Unix timestamp of the last update to the email.
                        example: 1773856017
                      content:
                        type: object
                        description: The content of your email.
                        properties:
                          subject:
                            type: string
                            description: Email subject line.
                          preheader_text:
                            type: string
                            description: Preview text.
                          html:
                            type: string
                            description: HTML body.
                          amp:
                            type: string
                            description: AMP HTML body.
                          text:
                            type: string
                            description: Plain text body.
                      envelope:
                        type: object
                        properties:
                          from_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Sender identity ID.

                              '
                          from:
                            type: string
                            description: The sender address associated with the from_id.
                          reply_to_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Reply-to identity ID. This matches one of the ids in *Workspace Settings > Email*.

                              '
                          reply_to:
                            type: string
                            description: The reply-to address associated with the reply_to_id.
                          bcc:
                            type: string
                            description: BCC email address.
                          fake_bcc:
                            type: boolean
                            description: Whether to use fake BCC. Defaults to true if not provided.
                          headers:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                value:
                                  type: string
                            description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                              '
                          recipient:
                            type: string
                            description: Recipient expression. Defaults to {{customer.email}} if not set.
                      transformers:
                        type: object
                        description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                        properties:
                          url_parameters:
                            type: object
                            description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable URL parameter injection.

                                  '
                                default: false
                              parameters:
                                type: array
                                description: 'List of parameters to append to URLs.

                                  '
                                default: []
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      description: 'Parameter name.

                                        '
                                    value:
                                      type: string
                                      description: 'Parameter value. May contain template variables.

                                        '
                                    url_encode:
                                      type: boolean
                                      description: 'URL-encode the value before appending it to the URL.

                                        '
                          css_variables:
                            type: object
                            description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS variable resolution.

                                  '
                                default: false
                              preserve:
                                type: boolean
                                description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                                  '
                                default: false
                          css_inliner:
                            type: object
                            description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS inlining.

                                  '
                                default: false
                              apply_style_tags:
                                type: boolean
                                description: 'Inline styles from `<style>` tags.

                                  '
                                default: true
                              preserve_important:
                                type: boolean
                                description: 'Preserve `!important` declarations in inlined styles.

                                  '
                                default: false
                              remove_style_tags:
                                type: boolean
                                description: 'Remove `<style>` tags after inlining their rules.

                                  '
                                default: true
                              preserve_font_faces:
                                type: boolean
                                description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_media_queries:
                                type: boolean
                                description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_keyframes:
                                type: boolean
                                description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_pseudos:
                                type: boolean
                                description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                                  '
                                default: true
                              inline_pseudo_elements:
                                type: boolean
                                description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                                  '
                                default: false
                              apply_html_attributes:
                                type: object
                                description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                                  '
                                properties:
                                  enabled:
                                    type: boolean
                                    description: 'Enable adding redundant HTML attributes.

                                      '
                                    default: true
                                  apply_width_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                      '
                                    default: true
                                  apply_height_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                      '
                                    default: true
                                  apply_table_element_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                      '
                                    default: true
                          accessibility:
                            type: object
                            description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable accessibility fixes.

                                  '
                                default: false
                              language:
                                type: string
                                description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                                  '
                                default: ''
                              add_lang_to_html:
                                type: boolean
                                description: 'Add `lang` attribute to the `<html>` element if not already present.

                                  '
                                default: true
                              add_dir_to_html:
                                type: boolean
                                description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                                  '
                                default: true
                              add_lang_to_content:
                                type: boolean
                                description: 'Add `lang` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_dir_to_content:
                                type: boolean
                                description: 'Add `dir` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_role_to_tables:
                                type: boolean
                                description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                                  '
                                default: true
                              add_vml_alt_text:
                                type: boolean
                                description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                                  '
                                default: true
                              add_empty_alt_to_images:
                                type: boolean
                                description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                                  '
                                default: true
                              add_title_to_head:
                                type: boolean
                                description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                                  '
                                default: true
                              remove_button_role_from_links:
                                type: boolean
                                description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                                  '
                                default: true
                              remove_zoom_meta_tag:
                                type: boolean
                                description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                                  '
                                default: true
                          formatter:
                            type: object
                            description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                              '
                            properties:
                              type:
                                type: string
                                description: 'Formatting mode to apply.

                                  '
                                enum:
                                - none
                                - prettify
                                - minify
                                default: none
                              prettify:
                                type: object
                                description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                                  '
                                properties:
                                  indent_character:
                                    type: string
                                    description: 'Character used for indentation.

                                      '
                                    enum:
                                    - spaces
                                    - tabs
                                    default: spaces
                                  indent_size:
                                    type: integer
                                    description: 'Number of indent characters per level.

                                      '
                                    default: 2
                                  wrap_attributes:
                                    type: boolean
                                    description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                      '
                                    default: false
                              minify:
                                type: object
                                description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                                  '
                                properties:
                                  remove_line_breaks:
                                    type: boolean
                                    description: 'Remove all line breaks from the output.

                                      '
                                    default: false
                                  line_length_limit:
                                    type: integer
                                    description: 'Maximum characters per line before inserting a line break.

                                      '
                                    default: 500
                                  remove_indentations:
                                    type: boolean
                                    description: 'Remove leading whitespace indentation.

                                      '
                                    default: true
                                  remove_html_comments:
                                    type: string
                                    description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                      '
                                    enum:
                                    - '0'
                                    - '1'
                                    - '2'
                                    default: '0'
                                  remove_css_comments:
                                    type: boolean
                                    description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                      '
                                    default: true
                          prevent_widows:
                            type: object
                            description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable widow word prevention.

                                  '
                                default: false
                          encode_entities:
                            type: object
                            description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable HTML entity encoding.

                                  '
                                default: false
                          remove_unused_css:
                            type: object
                            description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable unused CSS removal.

                                  '
                                default: false
                              whitelist:
                                type: array
                                description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                                items:
                                  type: string
                                  description: 'A CSS selector to always keep.

                                    '
                              backend_markers:
                                type: array
                                description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                                  '
                                default:
                                - heads: ''
                                  tails: ''
                                - heads: '{%'
                                  tails: '%}'
                                items:
                                  type: object
                                  properties:
                                    heads:
                                      type: string
                                      description: 'Opening delimiter.

                                        '
                                    tails:
                                      type: string
                                      description: 'Closing delimiter.

                                        '
                              uglify:
                                type: boolean
                                description: 'Shorten (uglify) CSS class names to reduce file size.

                                  '
                                default: false
        '400':
          description: "Bad request. Possible reasons:\n  - Missing or invalid name\n  - Missing content or any required content sub-field\n  - Unknown JSON field in content, envelope, or transformers\n  - from_id or reply_to_id does not reference an existing identity\n  - parent_folder_id is an empty string\n"
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: json
        label: JSON
        source: "{\n  \"name\": \"string\"\n}"
      - lang: Shell + Curl
        source: "curl --request POST \\\n  --url https://api.customer.io/v1/design_studio/emails \\\n  --header 'content-type: application/json' \\\n  --data '{\"name\":\"string\",\"is_template\":false,\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"POST\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  name: 'string',\n  is_template: false,\n  parent_folder_id: '26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec',\n  content: {\n    subject: 'string',\n    preheader_text: 'string',\n    html: 'string',\n    amp: 'string',\n    text: 'string'\n  },\n  envelope: {\n    from_id: 0,\n    reply_to_id: 0,\n    recipient: 'string',\n    bcc: 'string',\n    fake_bcc: true,\n    headers: [{name: 'string', value: 'string'}]\n  },\n  transformers: {\n    url_parameters: {enabled: false, parameters: []},\n    css_variables: {enabled: false, preserve: false},\n    css_inliner: {\n      enabled: false,\n      apply_style_tags: true,\n      preserve_important: false,\n      remove_style_tags: true,\n      preserve_font_faces: true,\n      preserve_media_queries: true,\n      preserve_keyframes: true,\n      preserve_pseudos: true,\n      inline_pseudo_elements: false,\n      apply_html_attributes: {\n        enabled: true,\n        apply_width_attributes: true,\n        apply_height_attributes: true,\n        apply_table_element_attributes: true\n      }\n    },\n    accessibility: {\n      enabled: false,\n      language: '',\n      add_lang_to_html: true,\n      add_dir_to_html: true,\n      add_lang_to_content: true,\n      add_dir_to_content: true,\n      add_role_to_tables: true,\n      add_vml_alt_text: true,\n      add_empty_alt_to_images: true,\n      add_title_to_head: true,\n      remove_button_role_from_links: true,\n      remove_zoom_meta_tag: true\n    },\n    formatter: {\n      type: 'none',\n      prettify: {indent_character: 'spaces', indent_size: 2, wrap_attributes: false},\n      minify: {\n        remove_line_breaks: false,\n        line_length_limit: 500,\n        remove_indentations: true,\n        remove_html_comments: '0',\n        remove_css_comments: true\n      }\n    },\n    prevent_widows: {enabled: false},\n    encode_entities: {enabled: false},\n    remove_unused_css: {\n      enabled: false,\n      whitelist: ['string'],\n      backend_markers: [{heads: '', tails: ''}, {heads: '{%', tails: '%}'}],\n      uglify: false\n    }\n  }\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Post.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"name\":\"string\",\"is_template\":false,\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"name\":\"string\",\"is_template\":false,\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          headers = { ''content-type'': "application/json" }


          conn.request("POST", "/v1/design_studio/emails", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"is_template\\\":false,\\\"parent_folder_id\\\":\\\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\\\",\\\"content\\\":{\\\"subject\\\":\\\"string\\\",\\\"preheader_text\\\":\\\"string\\\",\\\"html\\\":\\\"string\\\",\\\"amp\\\":\\\"string\\\",\\\"text\\\":\\\"string\\\"},\\\"envelope\\\":{\\\"from_id\\\":0,\\\"reply_to_id\\\":0,\\\"recipient\\\":\\\"string\\\",\\\"bcc\\\":\\\"string\\\",\\\"fake_bcc\\\":true,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]},\\\"transformers\\\":{\\\"url_parameters\\\":{\\\"enabled\\\":false,\\\"parameters\\\":[]},\\\"css_variables\\\":{\\\"enabled\\\":false,\\\"preserve\\\":false},\\\"css_inliner\\\":{\\\"enabled\\\":false,\\\"apply_style_tags\\\":true,\\\"preserve_important\\\":false,\\\"remove_style_tags\\\":true,\\\"preserve_font_faces\\\":true,\\\"preserve_media_queries\\\":true,\\\"preserve_keyframes\\\":true,\\\"preserve_pseudos\\\":true,\\\"inline_pseudo_elements\\\":false,\\\"apply_html_attributes\\\":{\\\"enabled\\\":true,\\\"apply_width_attributes\\\":true,\\\"apply_height_attributes\\\":true,\\\"apply_table_element_attributes\\\":true}},\\\"accessibility\\\":{\\\"enabled\\\":false,\\\"language\\\":\\\"\\\",\\\"add_lang_to_html\\\":true,\\\"add_dir_to_html\\\":true,\\\"add_lang_to_content\\\":true,\\\"add_dir_to_content\\\":true,\\\"add_role_to_tables\\\":true,\\\"add_vml_alt_text\\\":true,\\\"add_empty_alt_to_images\\\":true,\\\"add_title_to_head\\\":true,\\\"remove_button_role_from_links\\\":true,\\\"remove_zoom_meta_tag\\\":true},\\\"formatter\\\":{\\\"type\\\":\\\"none\\\",\\\"prettify\\\":{\\\"indent_character\\\":\\\"spaces\\\",\\\"indent_size\\\":2,\\\"wrap_attributes\\\":false},\\\"minify\\\":{\\\"remove_line_breaks\\\":false,\\\"line_length_limit\\\":500,\\\"remove_indentations\\\":true,\\\"remove_html_comments\\\":\\\"0\\\",\\\"remove_css_comments\\\":true}},\\\"prevent_widows\\\":{\\\"enabled\\\":false},\\\"encode_entities\\\":{\\\"enabled\\\":false},\\\"remove_unused_css\\\":{\\\"enabled\\\":false,\\\"whitelist\\\":[\\\"string\\\"],\\\"backend_markers\\\":[{\\\"heads\\\":\\\"\\\",\\\"tails\\\":\\\"\\\"},{\\\"heads\\\":\\\"{%\\\",\\\"tails\\\":\\\"%}\\\"}],\\\"uglify\\\":false}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/emails/{id}:
    get:
      tags:
      - Design Studio
      summary: Get an email
      description: 'Returns a single email including content, envelope details, and transformers. This endpoint returns only default emails; see [Email translations](#tag/design-studio/createEmailTranslation) to access language variants.

        '
      operationId: getEmail
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier for the email.
                        example: sdflkj345
                      name:
                        type: string
                        description: Display name of the email.
                      is_template:
                        type: boolean
                        description: Whether the email is a reusable template.
                      is_linked:
                        type: boolean
                        description: 'Whether the email is currently linked to a workflow (campaign, broadcast, etc).

                          '
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: 'UUID of the parent folder, or `null` if the email is in your root directory.

                          '
                      available_languages:
                        type: array
                        items:
                          type: string
                        description: List of [language codes](/journeys/channels/localization/attribute/#supported-languages) that reflect the languages this default email has been translated to.
                        example:
                        - en
                        - es
                      created:
                        type: integer
                        format: int64
                        description: Unix timestamp of when the email was created.
                        example: 1773856017
                      updated:
                        type: integer
                        format: int64
                        description: Unix timestamp of the last update to the email.
                        example: 1773856017
                      content:
                        type: object
                        description: The content of your email.
                        properties:
                          subject:
                            type: string
                            description: Email subject line.
                          preheader_text:
                            type: string
                            description: Preview text.
                          html:
                            type: string
                            description: HTML body.
                          amp:
                            type: string
                            description: AMP HTML body.
                          text:
                            type: string
                            description: Plain text body.
                      envelope:
                        type: object
                        properties:
                          from_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Sender identity ID.

                              '
                          from:
                            type: string
                            description: The sender address associated with the from_id.
                          reply_to_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Reply-to identity ID. This matches one of the ids in *Workspace Settings > Email*.

                              '
                          reply_to:
                            type: string
                            description: The reply-to address associated with the reply_to_id.
                          bcc:
                            type: string
                            description: BCC email address.
                          fake_bcc:
                            type: boolean
                            description: Whether to use fake BCC. Defaults to true if not provided.
                          headers:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                value:
                                  type: string
                            description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                              '
                          recipient:
                            type: string
                            description: Recipient expression. Defaults to {{customer.email}} if not set.
                      transformers:
                        type: object
                        description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                        properties:
                          url_parameters:
                            type: object
                            description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable URL parameter injection.

                                  '
                                default: false
                              parameters:
                                type: array
                                description: 'List of parameters to append to URLs.

                                  '
                                default: []
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      description: 'Parameter name.

                                        '
                                    value:
                                      type: string
                                      description: 'Parameter value. May contain template variables.

                                        '
                                    url_encode:
                                      type: boolean
                                      description: 'URL-encode the value before appending it to the URL.

                                        '
                          css_variables:
                            type: object
                            description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS variable resolution.

                                  '
                                default: false
                              preserve:
                                type: boolean
                                description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                                  '
                                default: false
                          css_inliner:
                            type: object
                            description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS inlining.

                                  '
                                default: false
                              apply_style_tags:
                                type: boolean
                                description: 'Inline styles from `<style>` tags.

                                  '
                                default: true
                              preserve_important:
                                type: boolean
                                description: 'Preserve `!important` declarations in inlined styles.

                                  '
                                default: false
                              remove_style_tags:
                                type: boolean
                                description: 'Remove `<style>` tags after inlining their rules.

                                  '
                                default: true
                              preserve_font_faces:
                                type: boolean
                                description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_media_queries:
                                type: boolean
                                description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_keyframes:
                                type: boolean
                                description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_pseudos:
                                type: boolean
                                description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                                  '
                                default: true
                              inline_pseudo_elements:
                                type: boolean
                                description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                                  '
                                default: false
                              apply_html_attributes:
                                type: object
                                description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                                  '
                                properties:
                                  enabled:
                                    type: boolean
                                    description: 'Enable adding redundant HTML attributes.

                                      '
                                    default: true
                                  apply_width_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                      '
                                    default: true
                                  apply_height_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                      '
                                    default: true
                                  apply_table_element_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                      '
                                    default: true
                          accessibility:
                            type: object
                            description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable accessibility fixes.

                                  '
                                default: false
                              language:
                                type: string
                                description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                                  '
                                default: ''
                              add_lang_to_html:
                                type: boolean
                                description: 'Add `lang` attribute to the `<html>` element if not already present.

                                  '
                                default: true
                              add_dir_to_html:
                                type: boolean
                                description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                                  '
                                default: true
                              add_lang_to_content:
                                type: boolean
                                description: 'Add `lang` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_dir_to_content:
                                type: boolean
                                description: 'Add `dir` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_role_to_tables:
                                type: boolean
                                description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                                  '
                                default: true
                              add_vml_alt_text:
                                type: boolean
                                description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                                  '
                                default: true
                              add_empty_alt_to_images:
                                type: boolean
                                description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                                  '
                                default: true
                              add_title_to_head:
                                type: boolean
                                description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                                  '
                                default: true
                              remove_button_role_from_links:
                                type: boolean
                                description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                                  '
                                default: true
                              remove_zoom_meta_tag:
                                type: boolean
                                description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                                  '
                                default: true
                          formatter:
                            type: object
                            description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                              '
                            properties:
                              type:
                                type: string
                                description: 'Formatting mode to apply.

                                  '
                                enum:
                                - none
                                - prettify
                                - minify
                                default: none
                              prettify:
                                type: object
                                description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                                  '
                                properties:
                                  indent_character:
                                    type: string
                                    description: 'Character used for indentation.

                                      '
                                    enum:
                                    - spaces
                                    - tabs
                                    default: spaces
                                  indent_size:
                                    type: integer
                                    description: 'Number of indent characters per level.

                                      '
                                    default: 2
                                  wrap_attributes:
                                    type: boolean
                                    description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                      '
                                    default: false
                              minify:
                                type: object
                                description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                                  '
                                properties:
                                  remove_line_breaks:
                                    type: boolean
                                    description: 'Remove all line breaks from the output.

                                      '
                                    default: false
                                  line_length_limit:
                                    type: integer
                                    description: 'Maximum characters per line before inserting a line break.

                                      '
                                    default: 500
                                  remove_indentations:
                                    type: boolean
                                    description: 'Remove leading whitespace indentation.

                                      '
                                    default: true
                                  remove_html_comments:
                                    type: string
                                    description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                      '
                                    enum:
                                    - '0'
                                    - '1'
                                    - '2'
                                    default: '0'
                                  remove_css_comments:
                                    type: boolean
                                    description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                      '
                                    default: true
                          prevent_widows:
                            type: object
                            description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable widow word prevention.

                                  '
                                default: false
                          encode_entities:
                            type: object
                            description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable HTML entity encoding.

                                  '
                                default: false
                          remove_unused_css:
                            type: object
                            description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable unused CSS removal.

                                  '
                                default: false
                              whitelist:
                                type: array
                                description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                                items:
                                  type: string
                                  description: 'A CSS selector to always keep.

                                    '
                              backend_markers:
                                type: array
                                description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                                  '
                                default:
                                - heads: ''
                                  tails: ''
                                - heads: '{%'
                                  tails: '%}'
                                items:
                                  type: object
                                  properties:
                                    heads:
                                      type: string
                                      description: 'Opening delimiter.

                                        '
                                    tails:
                                      type: string
                                      description: 'Closing delimiter.

                                        '
                              uglify:
                                type: boolean
                                description: 'Shorten (uglify) CSS class names to reduce file size.

                                  '
                                default: false
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/emails/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    put:
      tags:
      - Design Studio
      summary: Update an email
      description: 'Update part of an email: an email''s name, template status, folder, content, envelope, or transformers. Note, this does not publish your email; if the email is connected to a workflow like a campaign, you still need to click publish to make the changes live.

        '
      operationId: updateEmail
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        description: You must provide a body with at least one of the following properties. Omitting a field leaves it unchanged.
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Display name of the email.
                is_template:
                  type: boolean
                  description: Whether the email is a reusable template.
                parent_folder_id:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  description: 'The UUID of the parent folder.


                    Omit if you want no change to where the folder or file is located. Include `null` to move it to your root directory. Or add the UUID of another folder to move it there.

                    '
                content:
                  type: object
                  description: The content of your email.
                  properties:
                    subject:
                      type: string
                      description: Email subject line.
                    preheader_text:
                      type: string
                      description: Preview text.
                    html:
                      type: string
                      description: HTML body.
                    amp:
                      type: string
                      description: AMP HTML body.
                    text:
                      type: string
                      description: Plain text body.
                envelope:
                  type: object
                  description: The envelope of your email, like from and to addresses.
                  properties:
                    from_id:
                      type:
                      - integer
                      - 'null'
                      description: 'Sender identity ID. Must reference an existing identity. You can find this in *Workspace Settings > Email* under your From Addresses.

                        '
                    reply_to_id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                      description: 'Reply-to identity ID. Must reference an existing identity from *Workspace Settings > Email* under your From Addresses.

                        '
                    recipient:
                      type: string
                      description: 'Recipient email address. Defaults to `{{customer.email}}`` if not set.

                        '
                    bcc:
                      type: string
                      description: BCC email address.
                    fake_bcc:
                      type: boolean
                      description: Whether to use fake BCC. Defaults to true if not provided.
                    headers:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value:
                            type: string
                      description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                        '
                transformers:
                  type: object
                  description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                  properties:
                    url_parameters:
                      type: object
                      description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable URL parameter injection.

                            '
                          default: false
                        parameters:
                          type: array
                          description: 'List of parameters to append to URLs.

                            '
                          default: []
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: 'Parameter name.

                                  '
                              value:
                                type: string
                                description: 'Parameter value. May contain template variables.

                                  '
                              url_encode:
                                type: boolean
                                description: 'URL-encode the value before appending it to the URL.

                                  '
                    css_variables:
                      type: object
                      description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS variable resolution.

                            '
                          default: false
                        preserve:
                          type: boolean
                          description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                            '
                          default: false
                    css_inliner:
                      type: object
                      description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS inlining.

                            '
                          default: false
                        apply_style_tags:
                          type: boolean
                          description: 'Inline styles from `<style>` tags.

                            '
                          default: true
                        preserve_important:
                          type: boolean
                          description: 'Preserve `!important` declarations in inlined styles.

                            '
                          default: false
                        remove_style_tags:
                          type: boolean
                          description: 'Remove `<style>` tags after inlining their rules.

                            '
                          default: true
                        preserve_font_faces:
                          type: boolean
                          description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_media_queries:
                          type: boolean
                          description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_keyframes:
                          type: boolean
                          description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_pseudos:
                          type: boolean
                          description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                            '
                          default: true
                        inline_pseudo_elements:
                          type: boolean
                          description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                            '
                          default: false
                        apply_html_attributes:
                          type: object
                          description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                            '
                          properties:
                            enabled:
                              type: boolean
                              description: 'Enable adding redundant HTML attributes.

                                '
                              default: true
                            apply_width_attributes:
                              type: boolean
                              description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                '
                              default: true
                            apply_height_attributes:
                              type: boolean
                              description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                '
                              default: true
                            apply_table_element_attributes:
                              type: boolean
                              description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                '
                              default: true
                    accessibility:
                      type: object
                      description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable accessibility fixes.

                            '
                          default: false
                        language:
                          type: string
                          description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                            '
                          default: ''
                        add_lang_to_html:
                          type: boolean
                          description: 'Add `lang` attribute to the `<html>` element if not already present.

                            '
                          default: true
                        add_dir_to_html:
                          type: boolean
                          description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                            '
                          default: true
                        add_lang_to_content:
                          type: boolean
                          description: 'Add `lang` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_dir_to_content:
                          type: boolean
                          description: 'Add `dir` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_role_to_tables:
                          type: boolean
                          description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                            '
                          default: true
                        add_vml_alt_text:
                          type: boolean
                          description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                            '
                          default: true
                        add_empty_alt_to_images:
                          type: boolean
                          description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                            '
                          default: true
                        add_title_to_head:
                          type: boolean
                          description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                            '
                          default: true
                        remove_button_role_from_links:
                          type: boolean
                          description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                            '
                          default: true
                        remove_zoom_meta_tag:
                          type: boolean
                          description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                            '
                          default: true
                    formatter:
                      type: object
                      description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                        '
                      properties:
                        type:
                          type: string
                          description: 'Formatting mode to apply.

                            '
                          enum:
                          - none
                          - prettify
                          - minify
                          default: none
                        prettify:
                          type: object
                          description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                            '
                          properties:
                            indent_character:
                              type: string
                              description: 'Character used for indentation.

                                '
                              enum:
                              - spaces
                              - tabs
                              default: spaces
                            indent_size:
                              type: integer
                              description: 'Number of indent characters per level.

                                '
                              default: 2
                            wrap_attributes:
                              type: boolean
                              description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                '
                              default: false
                        minify:
                          type: object
                          description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                            '
                          properties:
                            remove_line_breaks:
                              type: boolean
                              description: 'Remove all line breaks from the output.

                                '
                              default: false
                            line_length_limit:
                              type: integer
                              description: 'Maximum characters per line before inserting a line break.

                                '
                              default: 500
                            remove_indentations:
                              type: boolean
                              description: 'Remove leading whitespace indentation.

                                '
                              default: true
                            remove_html_comments:
                              type: string
                              description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                '
                              enum:
                              - '0'
                              - '1'
                              - '2'
                              default: '0'
                            remove_css_comments:
                              type: boolean
                              description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                '
                              default: true
                    prevent_widows:
                      type: object
                      description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable widow word prevention.

                            '
                          default: false
                    encode_entities:
                      type: object
                      description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable HTML entity encoding.

                            '
                          default: false
                    remove_unused_css:
                      type: object
                      description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable unused CSS removal.

                            '
                          default: false
                        whitelist:
                          type: array
                          description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                          items:
                            type: string
                            description: 'A CSS selector to always keep.

                              '
                        backend_markers:
                          type: array
                          description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                            '
                          default:
                          - heads: ''
                            tails: ''
                          - heads: '{%'
                            tails: '%}'
                          items:
                            type: object
                            properties:
                              heads:
                                type: string
                                description: 'Opening delimiter.

                                  '
                              tails:
                                type: string
                                description: 'Closing delimiter.

                                  '
                        uglify:
                          type: boolean
                          description: 'Shorten (uglify) CSS class names to reduce file size.

                            '
                          default: false
      responses:
        '204':
          description: Email updated, no content returned
        '400':
          description: "Bad request. Possible reasons:\n  - No fields provided\n  - Invalid name\n  - Unknown JSON field in content, envelope, or transformers\n  - from_id or reply_to_id does not reference an existing identity\n  - parent_folder_id is an empty string\n"
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: json
        label: JSON
        source: '{}'
      - lang: Shell + Curl
        source: "curl --request PUT \\\n  --url https://api.customer.io/v1/design_studio/emails/{id} \\\n  --header 'content-type: application/json' \\\n  --data '{\"name\":\"string\",\"is_template\":true,\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"PUT\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  name: 'string',\n  is_template: true,\n  parent_folder_id: '26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec',\n  content: {\n    subject: 'string',\n    preheader_text: 'string',\n    html: 'string',\n    amp: 'string',\n    text: 'string'\n  },\n  envelope: {\n    from_id: 0,\n    reply_to_id: 0,\n    recipient: 'string',\n    bcc: 'string',\n    fake_bcc: true,\n    headers: [{name: 'string', value: 'string'}]\n  },\n  transformers: {\n    url_parameters: {enabled: false, parameters: []},\n    css_variables: {enabled: false, preserve: false},\n    css_inliner: {\n      enabled: false,\n      apply_style_tags: true,\n      preserve_important: false,\n      remove_style_tags: true,\n      preserve_font_faces: true,\n      preserve_media_queries: true,\n      preserve_keyframes: true,\n      preserve_pseudos: true,\n      inline_pseudo_elements: false,\n      apply_html_attributes: {\n        enabled: true,\n        apply_width_attributes: true,\n        apply_height_attributes: true,\n        apply_table_element_attributes: true\n      }\n    },\n    accessibility: {\n      enabled: false,\n      language: '',\n      add_lang_to_html: true,\n      add_dir_to_html: true,\n      add_lang_to_content: true,\n      add_dir_to_content: true,\n      add_role_to_tables: true,\n      add_vml_alt_text: true,\n      add_empty_alt_to_images: true,\n      add_title_to_head: true,\n      remove_button_role_from_links: true,\n      remove_zoom_meta_tag: true\n    },\n    formatter: {\n      type: 'none',\n      prettify: {indent_character: 'spaces', indent_size: 2, wrap_attributes: false},\n      minify: {\n        remove_line_breaks: false,\n        line_length_limit: 500,\n        remove_indentations: true,\n        remove_html_comments: '0',\n        remove_css_comments: true\n      }\n    },\n    prevent_widows: {enabled: false},\n    encode_entities: {enabled: false},\n    remove_unused_css: {\n      enabled: false,\n      whitelist: ['string'],\n      backend_markers: [{heads: '', tails: ''}, {heads: '{%', tails: '%}'}],\n      uglify: false\n    }\n  }\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Put.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"name\":\"string\",\"is_template\":true,\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"name\":\"string\",\"is_template\":true,\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          headers = { ''content-type'': "application/json" }


          conn.request("PUT", "/v1/design_studio/emails/%7Bid%7D", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"is_template\\\":true,\\\"parent_folder_id\\\":\\\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\\\",\\\"content\\\":{\\\"subject\\\":\\\"string\\\",\\\"preheader_text\\\":\\\"string\\\",\\\"html\\\":\\\"string\\\",\\\"amp\\\":\\\"string\\\",\\\"text\\\":\\\"string\\\"},\\\"envelope\\\":{\\\"from_id\\\":0,\\\"reply_to_id\\\":0,\\\"recipient\\\":\\\"string\\\",\\\"bcc\\\":\\\"string\\\",\\\"fake_bcc\\\":true,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]},\\\"transformers\\\":{\\\"url_parameters\\\":{\\\"enabled\\\":false,\\\"parameters\\\":[]},\\\"css_variables\\\":{\\\"enabled\\\":false,\\\"preserve\\\":false},\\\"css_inliner\\\":{\\\"enabled\\\":false,\\\"apply_style_tags\\\":true,\\\"preserve_important\\\":false,\\\"remove_style_tags\\\":true,\\\"preserve_font_faces\\\":true,\\\"preserve_media_queries\\\":true,\\\"preserve_keyframes\\\":true,\\\"preserve_pseudos\\\":true,\\\"inline_pseudo_elements\\\":false,\\\"apply_html_attributes\\\":{\\\"enabled\\\":true,\\\"apply_width_attributes\\\":true,\\\"apply_height_attributes\\\":true,\\\"apply_table_element_attributes\\\":true}},\\\"accessibility\\\":{\\\"enabled\\\":false,\\\"language\\\":\\\"\\\",\\\"add_lang_to_html\\\":true,\\\"add_dir_to_html\\\":true,\\\"add_lang_to_content\\\":true,\\\"add_dir_to_content\\\":true,\\\"add_role_to_tables\\\":true,\\\"add_vml_alt_text\\\":true,\\\"add_empty_alt_to_images\\\":true,\\\"add_title_to_head\\\":true,\\\"remove_button_role_from_links\\\":true,\\\"remove_zoom_meta_tag\\\":true},\\\"formatter\\\":{\\\"type\\\":\\\"none\\\",\\\"prettify\\\":{\\\"indent_character\\\":\\\"spaces\\\",\\\"indent_size\\\":2,\\\"wrap_attributes\\\":false},\\\"minify\\\":{\\\"remove_line_breaks\\\":false,\\\"line_length_limit\\\":500,\\\"remove_indentations\\\":true,\\\"remove_html_comments\\\":\\\"0\\\",\\\"remove_css_comments\\\":true}},\\\"prevent_widows\\\":{\\\"enabled\\\":false},\\\"encode_entities\\\":{\\\"enabled\\\":false},\\\"remove_unused_css\\\":{\\\"enabled\\\":false,\\\"whitelist\\\":[\\\"string\\\"],\\\"backend_markers\\\":[{\\\"heads\\\":\\\"\\\",\\\"tails\\\":\\\"\\\"},{\\\"heads\\\":\\\"{%\\\",\\\"tails\\\":\\\"%}\\\"}],\\\"uglify\\\":false}}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    delete:
      tags:
      - Design Studio
      summary: Delete an email
      description: 'Delete an email. You cannot delete an email that is linked to a workflow (campaign, broadcast, etc). This deletes the email and all translations.

        '
      operationId: deleteEmail
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Email deleted
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
        '409':
          description: Email is linked to a journey and cannot be deleted
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: cannot delete email because it is linked
                  status: 409
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request DELETE \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"DELETE\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Delete.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("DELETE", "/v1/design_studio/emails/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/emails/{id}/languages:
    get:
      tags:
      - Design Studio
      summary: List email translations
      description: 'Returns all translations for an email. Each translation contains the email''s content, envelope, and transformers for a specific language.

        '
      operationId: listEmailTranslations
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  email_translations:
                    type: array
                    items:
                      type: object
                      properties:
                        language_group_id:
                          type: string
                          format: uuid
                          description: ID of the parent email that groups all translations. Same as the id in the path parameter.
                        language:
                          type: string
                          description: The [language code](/journeys/channels/localization/attribute/#supported-languages) of the translation
                          example: fr
                        is_template:
                          type: boolean
                          description: Whether the translation is a template
                        is_linked:
                          type: boolean
                          description: Whether the translation is linked to a workflow (campaign, broadcast, etc)
                        parent_folder_id:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: UUID of the parent folder, or `null` if the email is in your root directory.
                        available_languages:
                          type: array
                          items:
                            type: string
                          description: List of [language codes](/journeys/channels/localization/attribute/#supported-languages) that reflect the languages this default email has been translated to.
                          example:
                          - en
                          - es
                        created:
                          type: integer
                          description: Unix timestamp of when the translation was created.
                          example: 1773856017
                        updated:
                          type: integer
                          description: Unix timestamp of the last update to the translation.
                          example: 1773856017
                        content:
                          type: object
                          description: The content of your email.
                          properties:
                            subject:
                              type: string
                              description: Email subject line.
                            preheader_text:
                              type: string
                              description: Preview text.
                            html:
                              type: string
                              description: HTML body.
                            amp:
                              type: string
                              description: AMP HTML body.
                            text:
                              type: string
                              description: Plain text body.
                        envelope:
                          type: object
                          properties:
                            from_id:
                              type:
                              - integer
                              - 'null'
                              description: 'Sender identity ID.

                                '
                            from:
                              type: string
                              description: The sender address associated with the from_id.
                            reply_to_id:
                              type:
                              - integer
                              - 'null'
                              description: 'Reply-to identity ID. This matches one of the ids in *Workspace Settings > Email*.

                                '
                            reply_to:
                              type: string
                              description: The reply-to address associated with the reply_to_id.
                            bcc:
                              type: string
                              description: BCC email address.
                            fake_bcc:
                              type: boolean
                              description: Whether to use fake BCC. Defaults to true if not provided.
                            headers:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  value:
                                    type: string
                              description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                                '
                            recipient:
                              type: string
                              description: Recipient expression. Defaults to {{customer.email}} if not set.
                        transformers:
                          type: object
                          description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                          properties:
                            url_parameters:
                              type: object
                              description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable URL parameter injection.

                                    '
                                  default: false
                                parameters:
                                  type: array
                                  description: 'List of parameters to append to URLs.

                                    '
                                  default: []
                                  items:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                        description: 'Parameter name.

                                          '
                                      value:
                                        type: string
                                        description: 'Parameter value. May contain template variables.

                                          '
                                      url_encode:
                                        type: boolean
                                        description: 'URL-encode the value before appending it to the URL.

                                          '
                            css_variables:
                              type: object
                              description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable CSS variable resolution.

                                    '
                                  default: false
                                preserve:
                                  type: boolean
                                  description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                                    '
                                  default: false
                            css_inliner:
                              type: object
                              description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable CSS inlining.

                                    '
                                  default: false
                                apply_style_tags:
                                  type: boolean
                                  description: 'Inline styles from `<style>` tags.

                                    '
                                  default: true
                                preserve_important:
                                  type: boolean
                                  description: 'Preserve `!important` declarations in inlined styles.

                                    '
                                  default: false
                                remove_style_tags:
                                  type: boolean
                                  description: 'Remove `<style>` tags after inlining their rules.

                                    '
                                  default: true
                                preserve_font_faces:
                                  type: boolean
                                  description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                                    '
                                  default: true
                                preserve_media_queries:
                                  type: boolean
                                  description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                                    '
                                  default: true
                                preserve_keyframes:
                                  type: boolean
                                  description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                                    '
                                  default: true
                                preserve_pseudos:
                                  type: boolean
                                  description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                                    '
                                  default: true
                                inline_pseudo_elements:
                                  type: boolean
                                  description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                                    '
                                  default: false
                                apply_html_attributes:
                                  type: object
                                  description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                                    '
                                  properties:
                                    enabled:
                                      type: boolean
                                      description: 'Enable adding redundant HTML attributes.

                                        '
                                      default: true
                                    apply_width_attributes:
                                      type: boolean
                                      description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                        '
                                      default: true
                                    apply_height_attributes:
                                      type: boolean
                                      description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                        '
                                      default: true
                                    apply_table_element_attributes:
                                      type: boolean
                                      description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                        '
                                      default: true
                            accessibility:
                              type: object
                              description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable accessibility fixes.

                                    '
                                  default: false
                                language:
                                  type: string
                                  description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                                    '
                                  default: ''
                                add_lang_to_html:
                                  type: boolean
                                  description: 'Add `lang` attribute to the `<html>` element if not already present.

                                    '
                                  default: true
                                add_dir_to_html:
                                  type: boolean
                                  description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                                    '
                                  default: true
                                add_lang_to_content:
                                  type: boolean
                                  description: 'Add `lang` attribute to direct children of `<body>`.

                                    '
                                  default: true
                                add_dir_to_content:
                                  type: boolean
                                  description: 'Add `dir` attribute to direct children of `<body>`.

                                    '
                                  default: true
                                add_role_to_tables:
                                  type: boolean
                                  description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                                    '
                                  default: true
                                add_vml_alt_text:
                                  type: boolean
                                  description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                                    '
                                  default: true
                                add_empty_alt_to_images:
                                  type: boolean
                                  description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                                    '
                                  default: true
                                add_title_to_head:
                                  type: boolean
                                  description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                                    '
                                  default: true
                                remove_button_role_from_links:
                                  type: boolean
                                  description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                                    '
                                  default: true
                                remove_zoom_meta_tag:
                                  type: boolean
                                  description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                                    '
                                  default: true
                            formatter:
                              type: object
                              description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                                '
                              properties:
                                type:
                                  type: string
                                  description: 'Formatting mode to apply.

                                    '
                                  enum:
                                  - none
                                  - prettify
                                  - minify
                                  default: none
                                prettify:
                                  type: object
                                  description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                                    '
                                  properties:
                                    indent_character:
                                      type: string
                                      description: 'Character used for indentation.

                                        '
                                      enum:
                                      - spaces
                                      - tabs
                                      default: spaces
                                    indent_size:
                                      type: integer
                                      description: 'Number of indent characters per level.

                                        '
                                      default: 2
                                    wrap_attributes:
                                      type: boolean
                                      description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                        '
                                      default: false
                                minify:
                                  type: object
                                  description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                                    '
                                  properties:
                                    remove_line_breaks:
                                      type: boolean
                                      description: 'Remove all line breaks from the output.

                                        '
                                      default: false
                                    line_length_limit:
                                      type: integer
                                      description: 'Maximum characters per line before inserting a line break.

                                        '
                                      default: 500
                                    remove_indentations:
                                      type: boolean
                                      description: 'Remove leading whitespace indentation.

                                        '
                                      default: true
                                    remove_html_comments:
                                      type: string
                                      description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                        '
                                      enum:
                                      - '0'
                                      - '1'
                                      - '2'
                                      default: '0'
                                    remove_css_comments:
                                      type: boolean
                                      description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                        '
                                      default: true
                            prevent_widows:
                              type: object
                              description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable widow word prevention.

                                    '
                                  default: false
                            encode_entities:
                              type: object
                              description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable HTML entity encoding.

                                    '
                                  default: false
                            remove_unused_css:
                              type: object
                              description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                                '
                              properties:
                                enabled:
                                  type: boolean
                                  description: 'Enable unused CSS removal.

                                    '
                                  default: false
                                whitelist:
                                  type: array
                                  description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                                  items:
                                    type: string
                                    description: 'A CSS selector to always keep.

                                      '
                                backend_markers:
                                  type: array
                                  description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                                    '
                                  default:
                                  - heads: ''
                                    tails: ''
                                  - heads: '{%'
                                    tails: '%}'
                                  items:
                                    type: object
                                    properties:
                                      heads:
                                        type: string
                                        description: 'Opening delimiter.

                                          '
                                      tails:
                                        type: string
                                        description: 'Closing delimiter.

                                          '
                                uglify:
                                  type: boolean
                                  description: 'Shorten (uglify) CSS class names to reduce file size.

                                    '
                                  default: false
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}/languages"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D/languages\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/emails/%7Bid%7D/languages")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    post:
      tags:
      - Design Studio
      summary: Create an email translation
      description: 'Creates a new translation for an email. If content, envelope, and/or transformers are omitted, the values are copied from the default (parent) email.

        '
      operationId: createEmailTranslation
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        description: "How content is inherited from the default, parent email:\n  - If both `content` and `envelope` are omitted: envelope (including subject and preheader) is copied verbatim from the parent email\n  - If `content` is provided but `envelope` is omitted: the envelope is reconstructed from the parent’s envelope settings, using the new subject and preheader\n  - If `envelope` is provided but `content` is omitted: the provided envelope is used with the parent’s subject and preheader\n  - HTML, AMP, and text body fields are always copied from parent if `content` is omitted\n"
        content:
          application/json:
            schema:
              type: object
              required:
              - language
              properties:
                language:
                  type: string
                  description: A [language code](/journeys/channels/localization/attribute/#supported-languages) that corresponds to the language of the translation
                  example: es
                content:
                  type: object
                  description: The content of your email.
                  properties:
                    subject:
                      type: string
                      description: Email subject line.
                    preheader_text:
                      type: string
                      description: Preview text.
                    html:
                      type: string
                      description: HTML body.
                    amp:
                      type: string
                      description: AMP HTML body.
                    text:
                      type: string
                      description: Plain text body.
                envelope:
                  type: object
                  description: The envelope of your email, like from and to addresses.
                  properties:
                    from_id:
                      type:
                      - integer
                      - 'null'
                      description: 'Sender identity ID. Must reference an existing identity. You can find this in *Workspace Settings > Email* under your From Addresses.

                        '
                    reply_to_id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                      description: 'Reply-to identity ID. Must reference an existing identity from *Workspace Settings > Email* under your From Addresses.

                        '
                    recipient:
                      type: string
                      description: 'Recipient email address. Defaults to `{{customer.email}}`` if not set.

                        '
                    bcc:
                      type: string
                      description: BCC email address.
                    fake_bcc:
                      type: boolean
                      description: Whether to use fake BCC. Defaults to true if not provided.
                    headers:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value:
                            type: string
                      description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                        '
                transformers:
                  type: object
                  description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                  properties:
                    url_parameters:
                      type: object
                      description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable URL parameter injection.

                            '
                          default: false
                        parameters:
                          type: array
                          description: 'List of parameters to append to URLs.

                            '
                          default: []
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: 'Parameter name.

                                  '
                              value:
                                type: string
                                description: 'Parameter value. May contain template variables.

                                  '
                              url_encode:
                                type: boolean
                                description: 'URL-encode the value before appending it to the URL.

                                  '
                    css_variables:
                      type: object
                      description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS variable resolution.

                            '
                          default: false
                        preserve:
                          type: boolean
                          description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                            '
                          default: false
                    css_inliner:
                      type: object
                      description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS inlining.

                            '
                          default: false
                        apply_style_tags:
                          type: boolean
                          description: 'Inline styles from `<style>` tags.

                            '
                          default: true
                        preserve_important:
                          type: boolean
                          description: 'Preserve `!important` declarations in inlined styles.

                            '
                          default: false
                        remove_style_tags:
                          type: boolean
                          description: 'Remove `<style>` tags after inlining their rules.

                            '
                          default: true
                        preserve_font_faces:
                          type: boolean
                          description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_media_queries:
                          type: boolean
                          description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_keyframes:
                          type: boolean
                          description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_pseudos:
                          type: boolean
                          description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                            '
                          default: true
                        inline_pseudo_elements:
                          type: boolean
                          description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                            '
                          default: false
                        apply_html_attributes:
                          type: object
                          description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                            '
                          properties:
                            enabled:
                              type: boolean
                              description: 'Enable adding redundant HTML attributes.

                                '
                              default: true
                            apply_width_attributes:
                              type: boolean
                              description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                '
                              default: true
                            apply_height_attributes:
                              type: boolean
                              description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                '
                              default: true
                            apply_table_element_attributes:
                              type: boolean
                              description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                '
                              default: true
                    accessibility:
                      type: object
                      description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable accessibility fixes.

                            '
                          default: false
                        language:
                          type: string
                          description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                            '
                          default: ''
                        add_lang_to_html:
                          type: boolean
                          description: 'Add `lang` attribute to the `<html>` element if not already present.

                            '
                          default: true
                        add_dir_to_html:
                          type: boolean
                          description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                            '
                          default: true
                        add_lang_to_content:
                          type: boolean
                          description: 'Add `lang` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_dir_to_content:
                          type: boolean
                          description: 'Add `dir` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_role_to_tables:
                          type: boolean
                          description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                            '
                          default: true
                        add_vml_alt_text:
                          type: boolean
                          description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                            '
                          default: true
                        add_empty_alt_to_images:
                          type: boolean
                          description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                            '
                          default: true
                        add_title_to_head:
                          type: boolean
                          description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                            '
                          default: true
                        remove_button_role_from_links:
                          type: boolean
                          description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                            '
                          default: true
                        remove_zoom_meta_tag:
                          type: boolean
                          description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                            '
                          default: true
                    formatter:
                      type: object
                      description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                        '
                      properties:
                        type:
                          type: string
                          description: 'Formatting mode to apply.

                            '
                          enum:
                          - none
                          - prettify
                          - minify
                          default: none
                        prettify:
                          type: object
                          description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                            '
                          properties:
                            indent_character:
                              type: string
                              description: 'Character used for indentation.

                                '
                              enum:
                              - spaces
                              - tabs
                              default: spaces
                            indent_size:
                              type: integer
                              description: 'Number of indent characters per level.

                                '
                              default: 2
                            wrap_attributes:
                              type: boolean
                              description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                '
                              default: false
                        minify:
                          type: object
                          description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                            '
                          properties:
                            remove_line_breaks:
                              type: boolean
                              description: 'Remove all line breaks from the output.

                                '
                              default: false
                            line_length_limit:
                              type: integer
                              description: 'Maximum characters per line before inserting a line break.

                                '
                              default: 500
                            remove_indentations:
                              type: boolean
                              description: 'Remove leading whitespace indentation.

                                '
                              default: true
                            remove_html_comments:
                              type: string
                              description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                '
                              enum:
                              - '0'
                              - '1'
                              - '2'
                              default: '0'
                            remove_css_comments:
                              type: boolean
                              description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                '
                              default: true
                    prevent_widows:
                      type: object
                      description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable widow word prevention.

                            '
                          default: false
                    encode_entities:
                      type: object
                      description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable HTML entity encoding.

                            '
                          default: false
                    remove_unused_css:
                      type: object
                      description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable unused CSS removal.

                            '
                          default: false
                        whitelist:
                          type: array
                          description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                          items:
                            type: string
                            description: 'A CSS selector to always keep.

                              '
                        backend_markers:
                          type: array
                          description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                            '
                          default:
                          - heads: ''
                            tails: ''
                          - heads: '{%'
                            tails: '%}'
                          items:
                            type: object
                            properties:
                              heads:
                                type: string
                                description: 'Opening delimiter.

                                  '
                              tails:
                                type: string
                                description: 'Closing delimiter.

                                  '
                        uglify:
                          type: boolean
                          description: 'Shorten (uglify) CSS class names to reduce file size.

                            '
                          default: false
      responses:
        '200':
          description: Translation created
          content:
            application/json:
              schema:
                type: object
                properties:
                  email_translation:
                    type: object
                    properties:
                      language_group_id:
                        type: string
                        format: uuid
                        description: ID of the parent email that groups all translations. Same as the id in the path parameter.
                      language:
                        type: string
                        description: The [language code](/journeys/channels/localization/attribute/#supported-languages) of the translation
                        example: fr
                      is_template:
                        type: boolean
                        description: Whether the translation is a template
                      is_linked:
                        type: boolean
                        description: Whether the translation is linked to a workflow (campaign, broadcast, etc)
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: UUID of the parent folder, or `null` if the email is in your root directory.
                      available_languages:
                        type: array
                        items:
                          type: string
                        description: List of [language codes](/journeys/channels/localization/attribute/#supported-languages) that reflect the languages this default email has been translated to.
                        example:
                        - en
                        - es
                      created:
                        type: integer
                        description: Unix timestamp of when the translation was created.
                        example: 1773856017
                      updated:
                        type: integer
                        description: Unix timestamp of the last update to the translation.
                        example: 1773856017
                      content:
                        type: object
                        description: The content of your email.
                        properties:
                          subject:
                            type: string
                            description: Email subject line.
                          preheader_text:
                            type: string
                            description: Preview text.
                          html:
                            type: string
                            description: HTML body.
                          amp:
                            type: string
                            description: AMP HTML body.
                          text:
                            type: string
                            description: Plain text body.
                      envelope:
                        type: object
                        properties:
                          from_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Sender identity ID.

                              '
                          from:
                            type: string
                            description: The sender address associated with the from_id.
                          reply_to_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Reply-to identity ID. This matches one of the ids in *Workspace Settings > Email*.

                              '
                          reply_to:
                            type: string
                            description: The reply-to address associated with the reply_to_id.
                          bcc:
                            type: string
                            description: BCC email address.
                          fake_bcc:
                            type: boolean
                            description: Whether to use fake BCC. Defaults to true if not provided.
                          headers:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                value:
                                  type: string
                            description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                              '
                          recipient:
                            type: string
                            description: Recipient expression. Defaults to {{customer.email}} if not set.
                      transformers:
                        type: object
                        description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                        properties:
                          url_parameters:
                            type: object
                            description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable URL parameter injection.

                                  '
                                default: false
                              parameters:
                                type: array
                                description: 'List of parameters to append to URLs.

                                  '
                                default: []
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      description: 'Parameter name.

                                        '
                                    value:
                                      type: string
                                      description: 'Parameter value. May contain template variables.

                                        '
                                    url_encode:
                                      type: boolean
                                      description: 'URL-encode the value before appending it to the URL.

                                        '
                          css_variables:
                            type: object
                            description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS variable resolution.

                                  '
                                default: false
                              preserve:
                                type: boolean
                                description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                                  '
                                default: false
                          css_inliner:
                            type: object
                            description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS inlining.

                                  '
                                default: false
                              apply_style_tags:
                                type: boolean
                                description: 'Inline styles from `<style>` tags.

                                  '
                                default: true
                              preserve_important:
                                type: boolean
                                description: 'Preserve `!important` declarations in inlined styles.

                                  '
                                default: false
                              remove_style_tags:
                                type: boolean
                                description: 'Remove `<style>` tags after inlining their rules.

                                  '
                                default: true
                              preserve_font_faces:
                                type: boolean
                                description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_media_queries:
                                type: boolean
                                description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_keyframes:
                                type: boolean
                                description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_pseudos:
                                type: boolean
                                description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                                  '
                                default: true
                              inline_pseudo_elements:
                                type: boolean
                                description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                                  '
                                default: false
                              apply_html_attributes:
                                type: object
                                description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                                  '
                                properties:
                                  enabled:
                                    type: boolean
                                    description: 'Enable adding redundant HTML attributes.

                                      '
                                    default: true
                                  apply_width_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                      '
                                    default: true
                                  apply_height_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                      '
                                    default: true
                                  apply_table_element_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                      '
                                    default: true
                          accessibility:
                            type: object
                            description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable accessibility fixes.

                                  '
                                default: false
                              language:
                                type: string
                                description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                                  '
                                default: ''
                              add_lang_to_html:
                                type: boolean
                                description: 'Add `lang` attribute to the `<html>` element if not already present.

                                  '
                                default: true
                              add_dir_to_html:
                                type: boolean
                                description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                                  '
                                default: true
                              add_lang_to_content:
                                type: boolean
                                description: 'Add `lang` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_dir_to_content:
                                type: boolean
                                description: 'Add `dir` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_role_to_tables:
                                type: boolean
                                description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                                  '
                                default: true
                              add_vml_alt_text:
                                type: boolean
                                description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                                  '
                                default: true
                              add_empty_alt_to_images:
                                type: boolean
                                description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                                  '
                                default: true
                              add_title_to_head:
                                type: boolean
                                description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                                  '
                                default: true
                              remove_button_role_from_links:
                                type: boolean
                                description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                                  '
                                default: true
                              remove_zoom_meta_tag:
                                type: boolean
                                description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                                  '
                                default: true
                          formatter:
                            type: object
                            description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                              '
                            properties:
                              type:
                                type: string
                                description: 'Formatting mode to apply.

                                  '
                                enum:
                                - none
                                - prettify
                                - minify
                                default: none
                              prettify:
                                type: object
                                description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                                  '
                                properties:
                                  indent_character:
                                    type: string
                                    description: 'Character used for indentation.

                                      '
                                    enum:
                                    - spaces
                                    - tabs
                                    default: spaces
                                  indent_size:
                                    type: integer
                                    description: 'Number of indent characters per level.

                                      '
                                    default: 2
                                  wrap_attributes:
                                    type: boolean
                                    description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                      '
                                    default: false
                              minify:
                                type: object
                                description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                                  '
                                properties:
                                  remove_line_breaks:
                                    type: boolean
                                    description: 'Remove all line breaks from the output.

                                      '
                                    default: false
                                  line_length_limit:
                                    type: integer
                                    description: 'Maximum characters per line before inserting a line break.

                                      '
                                    default: 500
                                  remove_indentations:
                                    type: boolean
                                    description: 'Remove leading whitespace indentation.

                                      '
                                    default: true
                                  remove_html_comments:
                                    type: string
                                    description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                      '
                                    enum:
                                    - '0'
                                    - '1'
                                    - '2'
                                    default: '0'
                                  remove_css_comments:
                                    type: boolean
                                    description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                      '
                                    default: true
                          prevent_widows:
                            type: object
                            description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable widow word prevention.

                                  '
                                default: false
                          encode_entities:
                            type: object
                            description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable HTML entity encoding.

                                  '
                                default: false
                          remove_unused_css:
                            type: object
                            description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable unused CSS removal.

                                  '
                                default: false
                              whitelist:
                                type: array
                                description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                                items:
                                  type: string
                                  description: 'A CSS selector to always keep.

                                    '
                              backend_markers:
                                type: array
                                description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                                  '
                                default:
                                - heads: ''
                                  tails: ''
                                - heads: '{%'
                                  tails: '%}'
                                items:
                                  type: object
                                  properties:
                                    heads:
                                      type: string
                                      description: 'Opening delimiter.

                                        '
                                    tails:
                                      type: string
                                      description: 'Closing delimiter.

                                        '
                              uglify:
                                type: boolean
                                description: 'Shorten (uglify) CSS class names to reduce file size.

                                  '
                                default: false
        '400':
          description: "Bad request. Possible reasons:\n  - Missing language\n  - Invalid language code\n  - Missing required content sub-field when content is provided\n  - Unknown JSON field in content, envelope, or transformers\n  - from_id or reply_to_id does not reference an existing identity\n"
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
        '409':
          description: Conflict - linked resource or other constraint violation
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: a constraint violation prevents this operation
                  status: 409
      x-codeSamples:
      - lang: json
        label: JSON
        source: "{\n  \"language\": \"es\"\n}"
      - lang: Shell + Curl
        source: "curl --request POST \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}/languages \\\n  --header 'content-type: application/json' \\\n  --data '{\"language\":\"es\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"POST\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D/languages\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  language: 'es',\n  content: {\n    subject: 'string',\n    preheader_text: 'string',\n    html: 'string',\n    amp: 'string',\n    text: 'string'\n  },\n  envelope: {\n    from_id: 0,\n    reply_to_id: 0,\n    recipient: 'string',\n    bcc: 'string',\n    fake_bcc: true,\n    headers: [{name: 'string', value: 'string'}]\n  },\n  transformers: {\n    url_parameters: {enabled: false, parameters: []},\n    css_variables: {enabled: false, preserve: false},\n    css_inliner: {\n      enabled: false,\n      apply_style_tags: true,\n      preserve_important: false,\n      remove_style_tags: true,\n      preserve_font_faces: true,\n      preserve_media_queries: true,\n      preserve_keyframes: true,\n      preserve_pseudos: true,\n      inline_pseudo_elements: false,\n      apply_html_attributes: {\n        enabled: true,\n        apply_width_attributes: true,\n        apply_height_attributes: true,\n        apply_table_element_attributes: true\n      }\n    },\n    accessibility: {\n      enabled: false,\n      language: '',\n      add_lang_to_html: true,\n      add_dir_to_html: true,\n      add_lang_to_content: true,\n      add_dir_to_content: true,\n      add_role_to_tables: true,\n      add_vml_alt_text: true,\n      add_empty_alt_to_images: true,\n      add_title_to_head: true,\n      remove_button_role_from_links: true,\n      remove_zoom_meta_tag: true\n    },\n    formatter: {\n      type: 'none',\n      prettify: {indent_character: 'spaces', indent_size: 2, wrap_attributes: false},\n      minify: {\n        remove_line_breaks: false,\n        line_length_limit: 500,\n        remove_indentations: true,\n        remove_html_comments: '0',\n        remove_css_comments: true\n      }\n    },\n    prevent_widows: {enabled: false},\n    encode_entities: {enabled: false},\n    remove_unused_css: {\n      enabled: false,\n      whitelist: ['string'],\n      backend_markers: [{heads: '', tails: ''}, {heads: '{%', tails: '%}'}],\n      uglify: false\n    }\n  }\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Post.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"language\":\"es\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"language\":\"es\",\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          headers = { ''content-type'': "application/json" }


          conn.request("POST", "/v1/design_studio/emails/%7Bid%7D/languages", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages\"\n\n\tpayload := strings.NewReader(\"{\\\"language\\\":\\\"es\\\",\\\"content\\\":{\\\"subject\\\":\\\"string\\\",\\\"preheader_text\\\":\\\"string\\\",\\\"html\\\":\\\"string\\\",\\\"amp\\\":\\\"string\\\",\\\"text\\\":\\\"string\\\"},\\\"envelope\\\":{\\\"from_id\\\":0,\\\"reply_to_id\\\":0,\\\"recipient\\\":\\\"string\\\",\\\"bcc\\\":\\\"string\\\",\\\"fake_bcc\\\":true,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]},\\\"transformers\\\":{\\\"url_parameters\\\":{\\\"enabled\\\":false,\\\"parameters\\\":[]},\\\"css_variables\\\":{\\\"enabled\\\":false,\\\"preserve\\\":false},\\\"css_inliner\\\":{\\\"enabled\\\":false,\\\"apply_style_tags\\\":true,\\\"preserve_important\\\":false,\\\"remove_style_tags\\\":true,\\\"preserve_font_faces\\\":true,\\\"preserve_media_queries\\\":true,\\\"preserve_keyframes\\\":true,\\\"preserve_pseudos\\\":true,\\\"inline_pseudo_elements\\\":false,\\\"apply_html_attributes\\\":{\\\"enabled\\\":true,\\\"apply_width_attributes\\\":true,\\\"apply_height_attributes\\\":true,\\\"apply_table_element_attributes\\\":true}},\\\"accessibility\\\":{\\\"enabled\\\":false,\\\"language\\\":\\\"\\\",\\\"add_lang_to_html\\\":true,\\\"add_dir_to_html\\\":true,\\\"add_lang_to_content\\\":true,\\\"add_dir_to_content\\\":true,\\\"add_role_to_tables\\\":true,\\\"add_vml_alt_text\\\":true,\\\"add_empty_alt_to_images\\\":true,\\\"add_title_to_head\\\":true,\\\"remove_button_role_from_links\\\":true,\\\"remove_zoom_meta_tag\\\":true},\\\"formatter\\\":{\\\"type\\\":\\\"none\\\",\\\"prettify\\\":{\\\"indent_character\\\":\\\"spaces\\\",\\\"indent_size\\\":2,\\\"wrap_attributes\\\":false},\\\"minify\\\":{\\\"remove_line_breaks\\\":false,\\\"line_length_limit\\\":500,\\\"remove_indentations\\\":true,\\\"remove_html_comments\\\":\\\"0\\\",\\\"remove_css_comments\\\":true}},\\\"prevent_widows\\\":{\\\"enabled\\\":false},\\\"encode_entities\\\":{\\\"enabled\\\":false},\\\"remove_unused_css\\\":{\\\"enabled\\\":false,\\\"whitelist\\\":[\\\"string\\\"],\\\"backend_markers\\\":[{\\\"heads\\\":\\\"\\\",\\\"tails\\\":\\\"\\\"},{\\\"heads\\\":\\\"{%\\\",\\\"tails\\\":\\\"%}\\\"}],\\\"uglify\\\":false}}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/emails/{id}/languages/{language}:
    get:
      tags:
      - Design Studio
      summary: Get an email translation
      description: 'Returns a single email translation by language code, including content, envelope, and transformers.

        '
      operationId: getEmailTranslation
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      - name: language
        in: path
        required: true
        schema:
          type: string
        description: A [language code](/journeys/channels/localization/attribute/#supported-languages) that indicates the language of your translated email
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  email_translation:
                    type: object
                    properties:
                      language_group_id:
                        type: string
                        format: uuid
                        description: ID of the parent email that groups all translations. Same as the id in the path parameter.
                      language:
                        type: string
                        description: The [language code](/journeys/channels/localization/attribute/#supported-languages) of the translation
                        example: fr
                      is_template:
                        type: boolean
                        description: Whether the translation is a template
                      is_linked:
                        type: boolean
                        description: Whether the translation is linked to a workflow (campaign, broadcast, etc)
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: UUID of the parent folder, or `null` if the email is in your root directory.
                      available_languages:
                        type: array
                        items:
                          type: string
                        description: List of [language codes](/journeys/channels/localization/attribute/#supported-languages) that reflect the languages this default email has been translated to.
                        example:
                        - en
                        - es
                      created:
                        type: integer
                        description: Unix timestamp of when the translation was created.
                        example: 1773856017
                      updated:
                        type: integer
                        description: Unix timestamp of the last update to the translation.
                        example: 1773856017
                      content:
                        type: object
                        description: The content of your email.
                        properties:
                          subject:
                            type: string
                            description: Email subject line.
                          preheader_text:
                            type: string
                            description: Preview text.
                          html:
                            type: string
                            description: HTML body.
                          amp:
                            type: string
                            description: AMP HTML body.
                          text:
                            type: string
                            description: Plain text body.
                      envelope:
                        type: object
                        properties:
                          from_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Sender identity ID.

                              '
                          from:
                            type: string
                            description: The sender address associated with the from_id.
                          reply_to_id:
                            type:
                            - integer
                            - 'null'
                            description: 'Reply-to identity ID. This matches one of the ids in *Workspace Settings > Email*.

                              '
                          reply_to:
                            type: string
                            description: The reply-to address associated with the reply_to_id.
                          bcc:
                            type: string
                            description: BCC email address.
                          fake_bcc:
                            type: boolean
                            description: Whether to use fake BCC. Defaults to true if not provided.
                          headers:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                value:
                                  type: string
                            description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                              '
                          recipient:
                            type: string
                            description: Recipient expression. Defaults to {{customer.email}} if not set.
                      transformers:
                        type: object
                        description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                        properties:
                          url_parameters:
                            type: object
                            description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable URL parameter injection.

                                  '
                                default: false
                              parameters:
                                type: array
                                description: 'List of parameters to append to URLs.

                                  '
                                default: []
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      description: 'Parameter name.

                                        '
                                    value:
                                      type: string
                                      description: 'Parameter value. May contain template variables.

                                        '
                                    url_encode:
                                      type: boolean
                                      description: 'URL-encode the value before appending it to the URL.

                                        '
                          css_variables:
                            type: object
                            description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS variable resolution.

                                  '
                                default: false
                              preserve:
                                type: boolean
                                description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                                  '
                                default: false
                          css_inliner:
                            type: object
                            description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable CSS inlining.

                                  '
                                default: false
                              apply_style_tags:
                                type: boolean
                                description: 'Inline styles from `<style>` tags.

                                  '
                                default: true
                              preserve_important:
                                type: boolean
                                description: 'Preserve `!important` declarations in inlined styles.

                                  '
                                default: false
                              remove_style_tags:
                                type: boolean
                                description: 'Remove `<style>` tags after inlining their rules.

                                  '
                                default: true
                              preserve_font_faces:
                                type: boolean
                                description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_media_queries:
                                type: boolean
                                description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_keyframes:
                                type: boolean
                                description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                                  '
                                default: true
                              preserve_pseudos:
                                type: boolean
                                description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                                  '
                                default: true
                              inline_pseudo_elements:
                                type: boolean
                                description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                                  '
                                default: false
                              apply_html_attributes:
                                type: object
                                description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                                  '
                                properties:
                                  enabled:
                                    type: boolean
                                    description: 'Enable adding redundant HTML attributes.

                                      '
                                    default: true
                                  apply_width_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                      '
                                    default: true
                                  apply_height_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                      '
                                    default: true
                                  apply_table_element_attributes:
                                    type: boolean
                                    description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                      '
                                    default: true
                          accessibility:
                            type: object
                            description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable accessibility fixes.

                                  '
                                default: false
                              language:
                                type: string
                                description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                                  '
                                default: ''
                              add_lang_to_html:
                                type: boolean
                                description: 'Add `lang` attribute to the `<html>` element if not already present.

                                  '
                                default: true
                              add_dir_to_html:
                                type: boolean
                                description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                                  '
                                default: true
                              add_lang_to_content:
                                type: boolean
                                description: 'Add `lang` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_dir_to_content:
                                type: boolean
                                description: 'Add `dir` attribute to direct children of `<body>`.

                                  '
                                default: true
                              add_role_to_tables:
                                type: boolean
                                description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                                  '
                                default: true
                              add_vml_alt_text:
                                type: boolean
                                description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                                  '
                                default: true
                              add_empty_alt_to_images:
                                type: boolean
                                description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                                  '
                                default: true
                              add_title_to_head:
                                type: boolean
                                description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                                  '
                                default: true
                              remove_button_role_from_links:
                                type: boolean
                                description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                                  '
                                default: true
                              remove_zoom_meta_tag:
                                type: boolean
                                description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                                  '
                                default: true
                          formatter:
                            type: object
                            description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                              '
                            properties:
                              type:
                                type: string
                                description: 'Formatting mode to apply.

                                  '
                                enum:
                                - none
                                - prettify
                                - minify
                                default: none
                              prettify:
                                type: object
                                description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                                  '
                                properties:
                                  indent_character:
                                    type: string
                                    description: 'Character used for indentation.

                                      '
                                    enum:
                                    - spaces
                                    - tabs
                                    default: spaces
                                  indent_size:
                                    type: integer
                                    description: 'Number of indent characters per level.

                                      '
                                    default: 2
                                  wrap_attributes:
                                    type: boolean
                                    description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                      '
                                    default: false
                              minify:
                                type: object
                                description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                                  '
                                properties:
                                  remove_line_breaks:
                                    type: boolean
                                    description: 'Remove all line breaks from the output.

                                      '
                                    default: false
                                  line_length_limit:
                                    type: integer
                                    description: 'Maximum characters per line before inserting a line break.

                                      '
                                    default: 500
                                  remove_indentations:
                                    type: boolean
                                    description: 'Remove leading whitespace indentation.

                                      '
                                    default: true
                                  remove_html_comments:
                                    type: string
                                    description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                      '
                                    enum:
                                    - '0'
                                    - '1'
                                    - '2'
                                    default: '0'
                                  remove_css_comments:
                                    type: boolean
                                    description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                      '
                                    default: true
                          prevent_widows:
                            type: object
                            description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable widow word prevention.

                                  '
                                default: false
                          encode_entities:
                            type: object
                            description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable HTML entity encoding.

                                  '
                                default: false
                          remove_unused_css:
                            type: object
                            description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                              '
                            properties:
                              enabled:
                                type: boolean
                                description: 'Enable unused CSS removal.

                                  '
                                default: false
                              whitelist:
                                type: array
                                description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                                items:
                                  type: string
                                  description: 'A CSS selector to always keep.

                                    '
                              backend_markers:
                                type: array
                                description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                                  '
                                default:
                                - heads: ''
                                  tails: ''
                                - heads: '{%'
                                  tails: '%}'
                                items:
                                  type: object
                                  properties:
                                    heads:
                                      type: string
                                      description: 'Opening delimiter.

                                        '
                                    tails:
                                      type: string
                                      description: 'Closing delimiter.

                                        '
                              uglify:
                                type: boolean
                                description: 'Shorten (uglify) CSS class names to reduce file size.

                                  '
                                default: false
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}/languages/{language}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    put:
      tags:
      - Design Studio
      summary: Update an email translation
      description: 'Update part of an email translation: the content, envelope, or transformers for a specific email translation. Note, this does not publish your email; if the email is connected to a workflow like a campaign, you still need to click publish to make the changes live.

        '
      operationId: updateEmailTranslation
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      - name: language
        in: path
        required: true
        schema:
          type: string
        description: A [language code](/journeys/channels/localization/attribute/#supported-languages) that indicates the language of your translated email
      requestBody:
        required: true
        description: You must provide a body with at least one of the following properties. Omitting a field leaves it unchanged.
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: object
                  description: The content of your email.
                  properties:
                    subject:
                      type: string
                      description: Email subject line.
                    preheader_text:
                      type: string
                      description: Preview text.
                    html:
                      type: string
                      description: HTML body.
                    amp:
                      type: string
                      description: AMP HTML body.
                    text:
                      type: string
                      description: Plain text body.
                envelope:
                  type: object
                  description: The envelope of your email, like from and to addresses.
                  properties:
                    from_id:
                      type:
                      - integer
                      - 'null'
                      description: 'Sender identity ID. Must reference an existing identity. You can find this in *Workspace Settings > Email* under your From Addresses.

                        '
                    reply_to_id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                      description: 'Reply-to identity ID. Must reference an existing identity from *Workspace Settings > Email* under your From Addresses.

                        '
                    recipient:
                      type: string
                      description: 'Recipient email address. Defaults to `{{customer.email}}`` if not set.

                        '
                    bcc:
                      type: string
                      description: BCC email address.
                    fake_bcc:
                      type: boolean
                      description: Whether to use fake BCC. Defaults to true if not provided.
                    headers:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value:
                            type: string
                      description: 'Custom headers. Each item: { "name": "string", "value": "string" }.

                        '
                transformers:
                  type: object
                  description: Automate repetitive actions like removing white space and inlining CSS with [transformers](/journeys/design-studio/emails/code-editor/overview/#transformers).
                  properties:
                    url_parameters:
                      type: object
                      description: 'Appends query string parameters to all absolute URLs in `<a>` and VML elements. Useful for adding UTM tracking or other analytics parameters. Skips `mailto:`, `tel:`, and `sms:` links. Elements marked with `data-ignore-params` are excluded.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable URL parameter injection.

                            '
                          default: false
                        parameters:
                          type: array
                          description: 'List of parameters to append to URLs.

                            '
                          default: []
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: 'Parameter name.

                                  '
                              value:
                                type: string
                                description: 'Parameter value. May contain template variables.

                                  '
                              url_encode:
                                type: boolean
                                description: 'URL-encode the value before appending it to the URL.

                                  '
                    css_variables:
                      type: object
                      description: 'Resolves CSS custom properties (`var(--name)`) into their computed values. Required for email clients that do not support CSS custom properties (most email clients). Variables declared in one `<style>` tag are available in subsequent `<style>` tags.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS variable resolution.

                            '
                          default: false
                        preserve:
                          type: boolean
                          description: 'Keep original custom property declarations (`--name: value`) alongside the resolved values.

                            '
                          default: false
                    css_inliner:
                      type: object
                      description: 'Moves CSS from `<style>` tags into inline `style` attributes on each element. Essential for email clients with limited `<style>` support (for example, older Gmail and some Outlook versions). Uses the `juice` library. Elements in `<style>` tags marked with `data-ignore-inlining` are skipped.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable CSS inlining.

                            '
                          default: false
                        apply_style_tags:
                          type: boolean
                          description: 'Inline styles from `<style>` tags.

                            '
                          default: true
                        preserve_important:
                          type: boolean
                          description: 'Preserve `!important` declarations in inlined styles.

                            '
                          default: false
                        remove_style_tags:
                          type: boolean
                          description: 'Remove `<style>` tags after inlining their rules.

                            '
                          default: true
                        preserve_font_faces:
                          type: boolean
                          description: 'Keep `@font-face` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_media_queries:
                          type: boolean
                          description: 'Keep `@media` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_keyframes:
                          type: boolean
                          description: 'Keep `@keyframes` rules in `<style>` (cannot be inlined).

                            '
                          default: true
                        preserve_pseudos:
                          type: boolean
                          description: 'Keep pseudo-selector rules (for example, `:hover`) in `<style>` (cannot be inlined).

                            '
                          default: true
                        inline_pseudo_elements:
                          type: boolean
                          description: 'Attempt to inline pseudo-element (`::before`, `::after`) styles.

                            '
                          default: false
                        apply_html_attributes:
                          type: object
                          description: 'Controls adding redundant HTML attributes alongside inlined CSS to different HTML elements.

                            '
                          properties:
                            enabled:
                              type: boolean
                              description: 'Enable adding redundant HTML attributes.

                                '
                              default: true
                            apply_width_attributes:
                              type: boolean
                              description: 'Add redundant HTML `width` attributes alongside inlined CSS `width` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS width (for example, older Outlook).

                                '
                              default: true
                            apply_height_attributes:
                              type: boolean
                              description: 'Add redundant HTML `height` attributes alongside inlined CSS `height` on `<table>`, `<td>`, `<th>`, and `<img>` elements. Only applies to `px` values (and `%` on table elements). Needed for email clients that ignore CSS height.

                                '
                              default: true
                            apply_table_element_attributes:
                              type: boolean
                              description: 'Add redundant HTML attributes on table elements (`<table>`, `<th>`, `<tr>`, `<td>`, `<caption>`, `<colgroup>`, `<col>`, `<thead>`, `<tbody>`, `<tfoot>`): `background-color` → `bgcolor`, `background-image` → `background`, `text-align` → `align`, `vertical-align` → `valign`.

                                '
                              default: true
                    accessibility:
                      type: object
                      description: 'Applies a set of accessibility improvements to the email HTML. When no `language` is set, this falls back to the `lang` attribute on the `<html>` tag, or `"und"` (undetermined). The `dir` attribute is automatically derived from the language using RTL detection.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable accessibility fixes.

                            '
                          default: false
                        language:
                          type: string
                          description: 'Language code (for example, `"en"`, `"fr"`, or `"ar"`) used for `lang` and `dir` attributes.

                            '
                          default: ''
                        add_lang_to_html:
                          type: boolean
                          description: 'Add `lang` attribute to the `<html>` element if not already present.

                            '
                          default: true
                        add_dir_to_html:
                          type: boolean
                          description: 'Add `dir` attribute (`ltr`, `rtl`, or `auto`) to the `<html>` element if not already present.

                            '
                          default: true
                        add_lang_to_content:
                          type: boolean
                          description: 'Add `lang` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_dir_to_content:
                          type: boolean
                          description: 'Add `dir` attribute to direct children of `<body>`.

                            '
                          default: true
                        add_role_to_tables:
                          type: boolean
                          description: 'Add `role="presentation"` to all `<table>` elements without an existing `role`, so screen readers skip table semantics for layout tables.

                            '
                          default: true
                        add_vml_alt_text:
                          type: boolean
                          description: 'Add `alt` attribute to VML elements (used by Outlook’s Word rendering engine), derived from the element’s text content.

                            '
                          default: true
                        add_empty_alt_to_images:
                          type: boolean
                          description: 'Add `alt=""` to `<img>` elements missing an `alt` attribute, preventing screen readers from reading the file name.

                            '
                          default: true
                        add_title_to_head:
                          type: boolean
                          description: 'Add a `<title>` tag to `<head>` using the email subject line (creates or replaces if empty).

                            '
                          default: true
                        remove_button_role_from_links:
                          type: boolean
                          description: 'Remove `role="button"` from `<a>` tags to restore proper link semantics for screen readers.

                            '
                          default: true
                        remove_zoom_meta_tag:
                          type: boolean
                          description: 'Remove viewport `<meta>` tags that restrict zoom (`user-scalable=0`, `user-scalable=no`, `maximum-scale=1`, or `maximum-scale=2`).

                            '
                          default: true
                    formatter:
                      type: object
                      description: 'Controls the output formatting of the final HTML. Only one mode (`prettify` or `minify`) can be active at a time. Set to `"none"` to skip formatting entirely.

                        '
                      properties:
                        type:
                          type: string
                          description: 'Formatting mode to apply.

                            '
                          enum:
                          - none
                          - prettify
                          - minify
                          default: none
                        prettify:
                          type: object
                          description: 'Options used when `type` is `"prettify"`. Produces human-readable, indented HTML output.

                            '
                          properties:
                            indent_character:
                              type: string
                              description: 'Character used for indentation.

                                '
                              enum:
                              - spaces
                              - tabs
                              default: spaces
                            indent_size:
                              type: integer
                              description: 'Number of indent characters per level.

                                '
                              default: 2
                            wrap_attributes:
                              type: boolean
                              description: 'Wrap HTML attributes onto separate lines (`force-expand-multiline` mode).

                                '
                              default: false
                        minify:
                          type: object
                          description: 'Options used when `type` is `"minify"`. Reduces file size by stripping whitespace and comments.

                            '
                          properties:
                            remove_line_breaks:
                              type: boolean
                              description: 'Remove all line breaks from the output.

                                '
                              default: false
                            line_length_limit:
                              type: integer
                              description: 'Maximum characters per line before inserting a line break.

                                '
                              default: 500
                            remove_indentations:
                              type: boolean
                              description: 'Remove leading whitespace indentation.

                                '
                              default: true
                            remove_html_comments:
                              type: string
                              description: 'HTML comment removal level. `"0"` keeps all comments, `"1"` removes non-conditional comments (preserves MSO conditionals like `<!--[if mso]>`), and `"2"` removes all comments including conditional.

                                '
                              enum:
                              - '0'
                              - '1'
                              - '2'
                              default: '0'
                            remove_css_comments:
                              type: boolean
                              description: 'Remove CSS comments (`/* ... */`) from `<style>` blocks.

                                '
                              default: true
                    prevent_widows:
                      type: object
                      description: 'Replaces the last space in text blocks with a non-breaking space (`&nbsp;`) to prevent a single word from wrapping onto its own line (a “widow”). Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags (`{{ }} ` and `{% %}`).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable widow word prevention.

                            '
                          default: false
                    encode_entities:
                      type: object
                      description: 'Encodes special characters (for example, `©`, `™`, and `—`) as their HTML entity equivalents. Improves rendering consistency across email clients with varying character encoding support. Only processes text nodes in the `<body>` and skips `<script>`, `<style>`, `<noscript>`, `<svg>`, and `<head>` elements. Preserves Liquid template tags and avoids double-encoding existing entities.

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable HTML entity encoding.

                            '
                          default: false
                    remove_unused_css:
                      type: object
                      description: 'Scans the HTML and removes any CSS selectors from `<style>` tags that are not referenced in the document. Reduces file size and helps avoid Gmail’s 102 KB clipping limit. HTML and CSS comments are always preserved by this step (comment removal is handled separately by the formatter object).

                        '
                      properties:
                        enabled:
                          type: boolean
                          description: 'Enable unused CSS removal.

                            '
                          default: false
                        whitelist:
                          type: array
                          description: "CSS selectors to always keep, even if they are not found in the HTML.\n  - .ReadMsgBody\n  - .ExternalClass\n  - .aBn\n  - .a6S\n  - .im\n  - .yshortcuts\n  - \"#outlook\"\n  - .MsoHyperlink\n  - .MsoHyperlinkFollowed\n"
                          items:
                            type: string
                            description: 'A CSS selector to always keep.

                              '
                        backend_markers:
                          type: array
                          description: 'Template syntax delimiters (e.g., Liquid, Handlebars) that the CSS parser should skip over to avoid treating template expressions as invalid CSS.

                            '
                          default:
                          - heads: ''
                            tails: ''
                          - heads: '{%'
                            tails: '%}'
                          items:
                            type: object
                            properties:
                              heads:
                                type: string
                                description: 'Opening delimiter.

                                  '
                              tails:
                                type: string
                                description: 'Closing delimiter.

                                  '
                        uglify:
                          type: boolean
                          description: 'Shorten (uglify) CSS class names to reduce file size.

                            '
                          default: false
      responses:
        '204':
          description: Translation updated
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: json
        label: JSON
        source: '{}'
      - lang: Shell + Curl
        source: "curl --request PUT \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}/languages/{language} \\\n  --header 'content-type: application/json' \\\n  --data '{\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"PUT\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  content: {\n    subject: 'string',\n    preheader_text: 'string',\n    html: 'string',\n    amp: 'string',\n    text: 'string'\n  },\n  envelope: {\n    from_id: 0,\n    reply_to_id: 0,\n    recipient: 'string',\n    bcc: 'string',\n    fake_bcc: true,\n    headers: [{name: 'string', value: 'string'}]\n  },\n  transformers: {\n    url_parameters: {enabled: false, parameters: []},\n    css_variables: {enabled: false, preserve: false},\n    css_inliner: {\n      enabled: false,\n      apply_style_tags: true,\n      preserve_important: false,\n      remove_style_tags: true,\n      preserve_font_faces: true,\n      preserve_media_queries: true,\n      preserve_keyframes: true,\n      preserve_pseudos: true,\n      inline_pseudo_elements: false,\n      apply_html_attributes: {\n        enabled: true,\n        apply_width_attributes: true,\n        apply_height_attributes: true,\n        apply_table_element_attributes: true\n      }\n    },\n    accessibility: {\n      enabled: false,\n      language: '',\n      add_lang_to_html: true,\n      add_dir_to_html: true,\n      add_lang_to_content: true,\n      add_dir_to_content: true,\n      add_role_to_tables: true,\n      add_vml_alt_text: true,\n      add_empty_alt_to_images: true,\n      add_title_to_head: true,\n      remove_button_role_from_links: true,\n      remove_zoom_meta_tag: true\n    },\n    formatter: {\n      type: 'none',\n      prettify: {indent_character: 'spaces', indent_size: 2, wrap_attributes: false},\n      minify: {\n        remove_line_breaks: false,\n        line_length_limit: 500,\n        remove_indentations: true,\n        remove_html_comments: '0',\n        remove_css_comments: true\n      }\n    },\n    prevent_widows: {enabled: false},\n    encode_entities: {enabled: false},\n    remove_unused_css: {\n      enabled: false,\n      whitelist: ['string'],\n      backend_markers: [{heads: '', tails: ''}, {heads: '{%', tails: '%}'}],\n      uglify: false\n    }\n  }\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Put.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"content\":{\"subject\":\"string\",\"preheader_text\":\"string\",\"html\":\"string\",\"amp\":\"string\",\"text\":\"string\"},\"envelope\":{\"from_id\":0,\"reply_to_id\":0,\"recipient\":\"string\",\"bcc\":\"string\",\"fake_bcc\":true,\"headers\":[{\"name\":\"string\",\"value\":\"string\"}]},\"transformers\":{\"url_parameters\":{\"enabled\":false,\"parameters\":[]},\"css_variables\":{\"enabled\":false,\"preserve\":false},\"css_inliner\":{\"enabled\":false,\"apply_style_tags\":true,\"preserve_important\":false,\"remove_style_tags\":true,\"preserve_font_faces\":true,\"preserve_media_queries\":true,\"preserve_keyframes\":true,\"preserve_pseudos\":true,\"inline_pseudo_elements\":false,\"apply_html_attributes\":{\"enabled\":true,\"apply_width_attributes\":true,\"apply_height_attributes\":true,\"apply_table_element_attributes\":true}},\"accessibility\":{\"enabled\":false,\"language\":\"\",\"add_lang_to_html\":true,\"add_dir_to_html\":true,\"add_lang_to_content\":true,\"add_dir_to_content\":true,\"add_role_to_tables\":true,\"add_vml_alt_text\":true,\"add_empty_alt_to_images\":true,\"add_title_to_head\":true,\"remove_button_role_from_links\":true,\"remove_zoom_meta_tag\":true},\"formatter\":{\"type\":\"none\",\"prettify\":{\"indent_character\":\"spaces\",\"indent_size\":2,\"wrap_attributes\":false},\"minify\":{\"remove_line_breaks\":false,\"line_length_limit\":500,\"remove_indentations\":true,\"remove_html_comments\":\"0\",\"remove_css_comments\":true}},\"prevent_widows\":{\"enabled\":false},\"encode_entities\":{\"enabled\":false},\"remove_unused_css\":{\"enabled\":false,\"whitelist\":[\"string\"],\"backend_markers\":[{\"heads\":\"\",\"tails\":\"\"},{\"heads\":\"{%\",\"tails\":\"%}\"}],\"uglify\":false}}}"


          headers = { ''content-type'': "application/json" }


          conn.request("PUT", "/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"content\\\":{\\\"subject\\\":\\\"string\\\",\\\"preheader_text\\\":\\\"string\\\",\\\"html\\\":\\\"string\\\",\\\"amp\\\":\\\"string\\\",\\\"text\\\":\\\"string\\\"},\\\"envelope\\\":{\\\"from_id\\\":0,\\\"reply_to_id\\\":0,\\\"recipient\\\":\\\"string\\\",\\\"bcc\\\":\\\"string\\\",\\\"fake_bcc\\\":true,\\\"headers\\\":[{\\\"name\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]},\\\"transformers\\\":{\\\"url_parameters\\\":{\\\"enabled\\\":false,\\\"parameters\\\":[]},\\\"css_variables\\\":{\\\"enabled\\\":false,\\\"preserve\\\":false},\\\"css_inliner\\\":{\\\"enabled\\\":false,\\\"apply_style_tags\\\":true,\\\"preserve_important\\\":false,\\\"remove_style_tags\\\":true,\\\"preserve_font_faces\\\":true,\\\"preserve_media_queries\\\":true,\\\"preserve_keyframes\\\":true,\\\"preserve_pseudos\\\":true,\\\"inline_pseudo_elements\\\":false,\\\"apply_html_attributes\\\":{\\\"enabled\\\":true,\\\"apply_width_attributes\\\":true,\\\"apply_height_attributes\\\":true,\\\"apply_table_element_attributes\\\":true}},\\\"accessibility\\\":{\\\"enabled\\\":false,\\\"language\\\":\\\"\\\",\\\"add_lang_to_html\\\":true,\\\"add_dir_to_html\\\":true,\\\"add_lang_to_content\\\":true,\\\"add_dir_to_content\\\":true,\\\"add_role_to_tables\\\":true,\\\"add_vml_alt_text\\\":true,\\\"add_empty_alt_to_images\\\":true,\\\"add_title_to_head\\\":true,\\\"remove_button_role_from_links\\\":true,\\\"remove_zoom_meta_tag\\\":true},\\\"formatter\\\":{\\\"type\\\":\\\"none\\\",\\\"prettify\\\":{\\\"indent_character\\\":\\\"spaces\\\",\\\"indent_size\\\":2,\\\"wrap_attributes\\\":false},\\\"minify\\\":{\\\"remove_line_breaks\\\":false,\\\"line_length_limit\\\":500,\\\"remove_indentations\\\":true,\\\"remove_html_comments\\\":\\\"0\\\",\\\"remove_css_comments\\\":true}},\\\"prevent_widows\\\":{\\\"enabled\\\":false},\\\"encode_entities\\\":{\\\"enabled\\\":false},\\\"remove_unused_css\\\":{\\\"enabled\\\":false,\\\"whitelist\\\":[\\\"string\\\"],\\\"backend_markers\\\":[{\\\"heads\\\":\\\"\\\",\\\"tails\\\":\\\"\\\"},{\\\"heads\\\":\\\"{%\\\",\\\"tails\\\":\\\"%}\\\"}],\\\"uglify\\\":false}}}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    delete:
      tags:
      - Design Studio
      summary: Delete an email translation
      description: 'Delete a specific language translation from an email. This fails if the email is linked to a workflow (campaign, broadcast, etc).

        '
      operationId: deleteEmailTranslation
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the email.
        schema:
          type: string
          format: uuid
      - name: language
        in: path
        required: true
        schema:
          type: string
        description: A [language code](/journeys/channels/localization/attribute/#supported-languages) that indicates the language of your translated email
      responses:
        '204':
          description: Translation deleted
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
        '409':
          description: Conflict - linked resource or other constraint violation
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: a constraint violation prevents this operation
                  status: 409
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request DELETE \\\n  --url https://api.customer.io/v1/design_studio/emails/{id}/languages/{language}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"DELETE\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Delete.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("DELETE", "/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/emails/%7Bid%7D/languages/%7Blanguage%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/components:
    get:
      tags:
      - Design Studio
      summary: List components
      description: Returns a paginated list of components and any folders in the result set.
      operationId: listComponents
      parameters:
      - name: tag
        in: query
        schema:
          type: string
        description: Filter by component tag name. This is the name of the tag inserted into your emails.
      - name: page
        in: query
        description: The page number of results you want to display. Use with `limit`.
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: limit
        in: query
        description: Limit the number of results per page.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
          default: 1000
      - name: parent_folder_id
        in: query
        schema:
          type: string
          format: uuid
        description: 'Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.


          To list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`.

          '
      - name: direct_descendants_only
        in: query
        description: If true, this returns only children of the parent folder.
        schema:
          type: boolean
          default: false
      - name: sort_by
        in: query
        schema:
          type: string
          enum:
          - created
          - updated
          - name
          default: created
      - name: sort_order
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: created_before
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records created before this time. Must be a unix timestamp.
        example: 1773856017
      - name: created_after
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records created after this time. Must be a unix timestamp.
        example: 1773856017
      - name: updated_before
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records updated before this time. Must be a unix timestamp.
        example: 1773856017
      - name: updated_after
        in: query
        schema:
          type: integer
          format: Unix timestamp
        description: Return records updated after this time. Must be a unix timestamp.
        example: 1773856017
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  components:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID of the component
                          example: e89b-12d3
                        name:
                          type: string
                          description: Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
                          example: Custom footer
                        tag:
                          type: string
                          description: The component tag name, used to reference your component in an email.
                          example: custom-footer
                        parent_folder_id:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: ID of the parent folder, or `null` if the component is in your root directory.
                          example: 123e4567-e89b-12d3-a456-426614174000
                        created:
                          type: integer
                          format: int64
                          description: Unix timestamp of when the component was created.
                          example: 1773856017
                        updated:
                          type: integer
                          format: int64
                          description: Unix timestamp of the last update to the component.
                          example: 1773856019
                  folders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID of folder
                        name:
                          type: string
                          description: The name of the folder.
                        parent_folder_id:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: The ID of the parent folder. Returns `null` if there is no parent, which means the folder is in the root directory.
                        created:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of when the folder was created.
                        updated:
                          type: integer
                          format: Unix timestamp
                          description: Timestamp of last update to the folder.
                      example:
                        id: 123e4567-e89b-12d3-a456-426614174000
                        name: Product Announcements
                        parent_folder_id: null
                        created: 1714732800
                        updated: 1714732800
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                            description: The page number of results you're on.
                          limit:
                            type: integer
                            description: The number of results per page.
                          total:
                            type: integer
                            description: The total number of folders.
                      filters:
                        type: object
                        description: The filters applied in your request.
                        example:
                          parent_folder_id: 123e4567-e89b-12d3-a456-426614174000
                          direct_descendants_only: true
                          sort_by: created
                          sort_order: desc
                          created_before: 1714732800
                          created_after: null
                          updated_before: null
                          updated_after: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url 'https://api.customer.io/v1/design_studio/components?tag=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/components?tag=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/components?tag=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/components?tag=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/components?tag=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&parent_folder_id=SOME_STRING_VALUE&direct_descendants_only=SOME_BOOLEAN_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&created_before=SOME_INTEGER_VALUE&created_after=SOME_INTEGER_VALUE&updated_before=SOME_INTEGER_VALUE&updated_after=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    post:
      tags:
      - Design Studio
      summary: Create a component
      description: Creates a custom component.
      operationId: createComponent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - tag
              - content
              properties:
                name:
                  type: string
                  description: Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
                  minLength: 1
                  maxLength: 255
                  example: Custom footer
                tag:
                  type: string
                  description: The component tag name, used to reference your component in an email. [Learn what characters you can use](/journeys/design-studio/reusable/components/code-custom-component/#component-tag-name-validation).
                  example: custom-footer
                parent_folder_id:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  description: UUID of the parent folder. Omit or pass `null` to create in the root directory.
                content:
                  type: string
                  description: HTML content
      responses:
        '200':
          description: Component created
          content:
            application/json:
              schema:
                type: object
                properties:
                  component:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: ID of the component
                        example: e89b-12d3
                      name:
                        type: string
                        description: Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
                        example: Custom footer
                      tag:
                        type: string
                        description: The component tag name, used to reference your component in an email.
                        example: custom-footer
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: ID of the parent folder, or `null` if the component is in your root directory.
                        example: 123e4567-e89b-12d3-a456-426614174000
                      created:
                        type: integer
                        format: int64
                        description: Unix timestamp of when the component was created.
                        example: 1773856017
                      updated:
                        type: integer
                        format: int64
                        description: Unix timestamp of the last update to the component.
                      content:
                        type: string
                        description: HTML content
        '400':
          description: "Bad request. Possible reasons:\n  - Missing or invalid name\n  - Missing or invalid tag\n  - parent_folder_id is an empty string\n  - Unknown JSON field in request body\n"
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
        '409':
          description: Conflict - linked resource or other constraint violation
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: a constraint violation prevents this operation
                  status: 409
      x-codeSamples:
      - lang: json
        label: JSON
        source: "{\n  \"name\": \"Custom footer\",\n  \"tag\": \"custom-footer\",\n  \"content\": \"string\"\n}"
      - lang: Shell + Curl
        source: "curl --request POST \\\n  --url https://api.customer.io/v1/design_studio/components \\\n  --header 'content-type: application/json' \\\n  --data '{\"name\":\"Custom footer\",\"tag\":\"custom-footer\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":\"string\"}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"POST\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/components\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  name: 'Custom footer',\n  tag: 'custom-footer',\n  parent_folder_id: '26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec',\n  content: 'string'\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/components")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Post.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"name\":\"Custom footer\",\"tag\":\"custom-footer\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":\"string\"}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"name\":\"Custom footer\",\"tag\":\"custom-footer\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":\"string\"}"


          headers = { ''content-type'': "application/json" }


          conn.request("POST", "/v1/design_studio/components", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/components\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"Custom footer\\\",\\\"tag\\\":\\\"custom-footer\\\",\\\"parent_folder_id\\\":\\\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\\\",\\\"content\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
  /v1/design_studio/components/{id}:
    get:
      tags:
      - Design Studio
      summary: Get a component
      description: Returns a single component with its full content.
      operationId: getComponent
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the component.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  component:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: ID of the component
                        example: e89b-12d3
                      name:
                        type: string
                        description: Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
                        example: Custom footer
                      tag:
                        type: string
                        description: The component tag name, used to reference your component in an email.
                        example: custom-footer
                      parent_folder_id:
                        type:
                        - string
                        - 'null'
                        format: uuid
                        description: ID of the parent folder, or `null` if the component is in your root directory.
                        example: 123e4567-e89b-12d3-a456-426614174000
                      created:
                        type: integer
                        format: int64
                        description: Unix timestamp of when the component was created.
                        example: 1773856017
                      updated:
                        type: integer
                        format: int64
                        description: Unix timestamp of the last update to the component.
                      content:
                        type: string
                        description: HTML content
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.customer.io/v1/design_studio/components/{id}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/components/%7Bid%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/components/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Get.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("GET", "/v1/design_studio/components/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/components/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    put:
      tags:
      - Design Studio
      summary: Update a component
      description: 'Update part of a component: its name, tag, folder, or content.

        '
      operationId: updateComponent
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the component.
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        description: You must provide a body with at least one of the following properties. Omitting a field leaves it unchanged.
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
                  example: custom-footer
                tag:
                  type: string
                  description: The component tag name, used to reference your component in an email. Learn what [characters](/journeys/design-studio/reusable/components/code-custom-component/#component-tag-name-validation) you can use.
                parent_folder_id:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  description: 'The UUID of the parent folder.


                    Omit if you want no change to where the folder or file is located. Include `null` to move it to your root directory. Or add the UUID of another folder to move it there.

                    '
                content:
                  type: string
                  description: HTML content
      responses:
        '204':
          description: Component updated
        '400':
          description: "Bad request. Possible reasons:\n  - No fields provided\n  - Invalid name\n  - Invalid tag\n  - parent_folder_id is an empty string\n  - Unknown JSON field in request body\n"
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
        '409':
          description: Conflict - linked resource or other constraint violation
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: a constraint violation prevents this operation
                  status: 409
      x-codeSamples:
      - lang: json
        label: JSON
        source: '{}'
      - lang: Shell + Curl
        source: "curl --request PUT \\\n  --url https://api.customer.io/v1/design_studio/components/{id} \\\n  --header 'content-type: application/json' \\\n  --data '{\"name\":\"custom-footer\",\"tag\":\"string\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":\"string\"}'"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"PUT\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/components/%7Bid%7D\",\n  \"headers\": {\n    \"content-type\": \"application/json\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  name: 'custom-footer',\n  tag: 'string',\n  parent_folder_id: '26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec',\n  content: 'string'\n}));\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/components/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Put.new(url)

          request["content-type"] = ''application/json''

          request.body = "{\"name\":\"custom-footer\",\"tag\":\"string\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":\"string\"}"


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          payload = "{\"name\":\"custom-footer\",\"tag\":\"string\",\"parent_folder_id\":\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\",\"content\":\"string\"}"


          headers = { ''content-type'': "application/json" }


          conn.request("PUT", "/v1/design_studio/components/%7Bid%7D", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/components/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"custom-footer\\\",\\\"tag\\\":\\\"string\\\",\\\"parent_folder_id\\\":\\\"26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec\\\",\\\"content\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
    delete:
      tags:
      - Design Studio
      summary: Delete a component
      description: Delete a component. Note, this deletes any component. If you delete a component in use, the emails that reference it could fail to send.
      operationId: deleteComponent
      parameters:
      - name: id
        in: path
        required: true
        description: The UUID of the component.
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Component deleted
        '401':
          description: Unauthorized - missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: unauthorized
                  status: 401
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                description: An error response containing one or more error details.
                properties:
                  errors:
                    type: array
                    description: A list of errors that occurred while processing the request.
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Reason for error
                        status:
                          type: integer
                          description: Response code
              example:
                errors:
                - detail: resource not found
                  status: 404
      x-codeSamples:
      - lang: Shell + Curl
        source: "curl --request DELETE \\\n  --url https://api.customer.io/v1/design_studio/components/{id}"
      - lang: Node + Native
        source: "const http = require(\"https\");\n\nconst options = {\n  \"method\": \"DELETE\",\n  \"hostname\": \"api.customer.io\",\n  \"port\": null,\n  \"path\": \"/v1/design_studio/components/%7Bid%7D\",\n  \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.end();"
      - lang: Ruby + Native
        source: 'require ''uri''

          require ''net/http''

          require ''openssl''


          url = URI("https://api.customer.io/v1/design_studio/components/%7Bid%7D")


          http = Net::HTTP.new(url.host, url.port)

          http.use_ssl = true

          http.verify_mode = OpenSSL::SSL::VERIFY_NONE


          request = Net::HTTP::Delete.new(url)


          response = http.request(request)

          puts response.read_body'
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.customer.io")


          conn.request("DELETE", "/v1/design_studio/components/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Go + Native
        source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.customer.io/v1/design_studio/components/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
components:
  securitySchemes:
    Bearer-Auth:
      type: http
      scheme: bearer
      description: 'The App API uses a bearer authentication scheme.


        You can generate a bearer token, known as an **App API Key**, with a defined scope in [your account settings](https://fly.customer.io/settings/api_credentials?keyType=app). [Learn more about bearer authorization in Customer.io](/accounts/settings/managing-credentials).

        '
    ServiceAccount-Auth:
      x-scalar-ignore: true
      type: http
      scheme: bearer
      bearerFormat: sa_live_
      description: 'Transactional send endpoints (`/v1/send/email`, `/v1/send/push`, `/v1/send/sms`, `/v1/send/in_app`, `/v1/send/inbox_message`) also accept a service-account bearer token, prefixed with `sa_live_`. Service-account tokens work across workspaces, so you must pass the target workspace as the `X-Workspace-Id` header on each request.


        Service-account tokens are intended for testing and one-off sends—for example, using the Customer.io CLI with an AI agent like Claude to verify that a transactional message renders correctly before wiring it into your production backend. **For the production integration that triggers the message from your application, use an App API Key instead**: it''s workspace-scoped, easier to rotate, and has a smaller blast radius.


        Service-account tokens are server-side credentials. Treat them like any API key—keep them in environment variables or a secret manager, and never embed them in client-side code, mobile apps, or other untrusted contexts.

        '
    bearerAuth:
      type: http
      scheme: bearer
      description: API key passed as a Bearer token