Optimizely

Optimizely Attachments API

Manage email attachments

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /{clientId}/attachments/count Count email attachments for a client · Get the total number of attachments #
Ask an LLM
“How many attachments are stored for my Optimizely Campaign client?”
“Can I get just the total attachment count without listing them?”
Tell an agent
Count the attachments for client {clientId}.
Tell me the total number of mailing attachments on client {clientId}.
GET /{clientId}/attachments List a client's email attachments · Get information about all attachments #
Ask an LLM
“What attachments does my client have, with their mime types and sizes?”
“Can I sort the attachment list by creation date and limit the results?”
Tell an agent
List all attachments for client {clientId}.
List {limit} attachments of client {clientId} sorted by {sort} {direction}.
POST /{clientId}/attachments Upload a new email attachment · Create an attachment #
Ask an LLM
“How do I upload a file to use as an attachment in my mailings?”
“Can I name an attachment when I upload it?”
Tell an agent
Upload {file} as a new attachment for client {clientId}.
Create attachment {name} from file {file} on client {clientId}.
GET /{clientId}/attachments/{attachmentId}/content Download an attachment's file content · Get the content of an uploaded attachment #
Ask an LLM
“How do I download the actual file behind an attachment?”
“Can I retrieve the uploaded content of one attachment?”
Tell an agent
Download the content of attachment {attachmentId} for client {clientId}.
Get the file bytes of attachment {attachmentId} on client {clientId}.
POST /{clientId}/attachments/{attachmentId}/content Replace an attachment's file content · Update the content of an uploaded attachment #
Ask an LLM
“Can I swap in a new file for an existing attachment without creating another one?”
“How do I re-upload the content of an attachment I already have?”
Tell an agent
Replace the file of attachment {attachmentId} on client {clientId} with {file}.
Re-upload {file} as the content of attachment {attachmentId} for client {clientId}.
GET /{clientId}/attachments/{attachmentId} Get an attachment's details · Get information about an attachment #
Ask an LLM
“What type, size and creation date does a specific attachment have?”
“Can I see the metadata of one attachment without downloading it?”
Tell an agent
Get details of attachment {attachmentId} for client {clientId}.
Show the metadata of attachment {attachmentId} on client {clientId}.
POST /{clientId}/attachments/{attachmentId} Rename or retype an attachment · Update attachment information #
Ask an LLM
“How do I rename an attachment or change its file name?”
“Can I correct the mime type recorded on an attachment?”
Tell an agent
Rename attachment {attachmentId} on client {clientId} to {name}.
Set the mime type of attachment {attachmentId} for client {clientId} to {mimeType}.
DELETE /{clientId}/attachments/{attachmentId} Delete an attachment · Delete an attachment #
Ask an LLM
“How do I remove an attachment I no longer use in mailings?”
“Is deleting an attachment permanent?”
Tell an agent destructive · confirm first
Delete attachment {attachmentId} from client {clientId}.
Remove mailing attachment {attachmentId} on client {clientId}.
POST /{clientId}/attachments/personalized Create a personalized attachment · Create a personalized attachment #
Ask an LLM
“How do I set up a personalized attachment that differs per recipient?”
“Can a personalized attachment be built from several files?”
Tell an agent
Create personalized attachment {name} from {file} for client {clientId}.
Upload files {file} as a per-recipient personalized attachment on client {clientId}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/optimizely/openapi/optimizely-attachments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-attachment-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-count-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-attachment-streaming-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-personalized-attachment-upload-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-attachment-request-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-multi-part-request-schema-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-attachments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-attachments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Attachments API
  description: This documentation lists all available resources and endpoints of the Optimizely Campaign REST API.
  version: '1'
servers:
- url: https://api.campaign.episerver.net/rest
tags:
- name: Attachments
  description: Manage email attachments
paths:
  /{clientId}/attachments/count:
    get:
      tags:
      - Attachments
      summary: Get the total number of attachments
      operationId: count_1
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The total number was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCount'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCount'
      security:
      - Authorization: []
  /{clientId}/attachments:
    get:
      tags:
      - Attachments
      summary: Get information about all attachments
      description: Get detailed information about all attachments, such as type, mime type, size or creation date. You can sort the result by specific criteria and limit the maximum number of retrieved attachments.
      operationId: getAllAttachments
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Starting point of the result list <p><i>Default value</i> : 0</p>'
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Maximum number of retrieved attachments<p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: Sort result by specific criteria
        schema:
          type: string
          default: created
          enum:
          - id
          - mailingGroup
          - name
          - uploaded
          - url
          - fileName
          - type
          - mimeType
          - size
          - created
          - modified
      - name: direction
        in: query
        description: Sort order
        schema:
          type: string
          default: ASC
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: The attachments were retrieved successfully (empty result if none were found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAttachmentStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestAttachmentStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Attachments
      summary: Create an attachment
      description: Create an attachment. You can specify name, mime type or attachment file.
      operationId: createAttachment
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RestMultiPartRequestSchema'
      responses:
        '201':
          description: The attachment was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
        '400':
          description: The parameters "name" and "file" are required or the file name has an invalid extension. Ensure that "name" and "file" parameters are added to the request and the file extension is correct.
      security:
      - Authorization: []
  /{clientId}/attachments/{attachmentId}/content:
    get:
      tags:
      - Attachments
      summary: Get the content of an uploaded attachment
      operationId: getUploadAttachment
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        description: Attachment ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The uploaded content attachment was downloaded successfully.
          content:
            application/octet-stream:
              schema:
                type: object
            application/vnd.optivo.broadmail.v1+json:
              schema:
                type: object
        '404':
          description: The attachment could not be found. Ensure that the required parameters such as "attachmentId" are correct and the attachment exists.
      security:
      - Authorization: []
    post:
      tags:
      - Attachments
      summary: Update the content of an uploaded attachment
      operationId: uploadAttachment
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        description: Attachment ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RestMultiPartRequestSchema'
      responses:
        '200':
          description: The attachment content was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
        '404':
          description: The attachment could not be found. Ensure that the required parameters such as "attachmentId" are correct and the attachment exists.
      security:
      - Authorization: []
  /{clientId}/attachments/{attachmentId}:
    get:
      tags:
      - Attachments
      summary: Get information about an attachment
      description: Get detailed information about an attachment, such as type, mime type, size or creation date.
      operationId: getAttachment
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        description: Attachment ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The attachment was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
      security:
      - Authorization: []
    post:
      tags:
      - Attachments
      summary: Update attachment information
      description: Update attachment information. You can specify name, file name or mime type.
      operationId: updateAttachment
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        description: Attachment ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AttachmentRequestData'
      responses:
        '200':
          description: The attachment was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestAttachment'
        '404':
          description: The attachment could not be found. Ensure that the required parameters such as "attachmentId" are correct and the attachment exists.
      security:
      - Authorization: []
    delete:
      tags:
      - Attachments
      summary: Delete an attachment
      operationId: deleteAttachment
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        description: Attachment ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The attachment was deleted successfully.
        '404':
          description: The attachment could not be found. Ensure that the required parameters such as "attachmentId" are correct and the attachment exists.
        '409':
          description: The attachment is being used by at least one mailing and can not be deleted
      security:
      - Authorization: []
  /{clientId}/attachments/personalized:
    post:
      tags:
      - Attachments
      summary: Create a personalized attachment
      description: Create a personalized attachment. You can specify the attachment name and attachment file(s).
      operationId: createAttachment_1
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RestMultiPartRequestSchema'
      responses:
        '200':
          description: The attachment was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestPersonalizedAttachmentUpload'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestPersonalizedAttachmentUpload'
        '400':
          description: An erroneous request was sent.
        '406':
          description: The uploaded file is empty.
        '500':
          description: The request could not be processed successfully.
      security:
      - Authorization: []
components:
  schemas:
    RestMultiPartRequestSchema:
      required:
      - file
      type: object
      properties:
        file:
          type: string
          description: file to be uploaded
          format: binary
        name:
          type: string
          description: name of the attachment
    RestAttachmentStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestAttachment'
        links:
          type: array
          writeOnly: true
          items:
            $ref: '#/components/schemas/RestApiLink'
        count:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
    RestAttachment:
      type: object
      properties:
        id:
          type: integer
          description: Attachment ID
          format: int64
        owner:
          type: integer
          description: Client ID
          format: int64
        name:
          type: string
          description: Attachment name
        uploaded:
          type: boolean
          description: If true, the attachment was successfully uploaded
        fileName:
          type: string
          description: File name
        type:
          type: string
          description: File type of the attachment
        mimeType:
          type: string
          description: Mime type of the attachment
        size:
          type: integer
          description: Attachment size
          format: int64
        created:
          type: string
          description: Date and time of creation
          format: date-time
        modified:
          type: string
          description: Date and time of modification
          format: date-time
        links:
          type: array
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
    RestApiLink:
      type: object
      properties:
        href:
          type: string
        rel:
          type: string
    RestPersonalizedAttachment:
      type: object
      properties:
        fileName:
          type: string
          description: File name
        fileSize:
          type: integer
          description: File size in bytes
          format: int64
        id:
          type: integer
          description: Attachment ID
          format: int64
        contentType:
          type: string
          description: File content type
        expiresAt:
          type: string
          description: Expiry date
          format: date-time
        created:
          type: string
          description: Creation date
          format: date-time
      description: List of uploaded attachments
    RestCount:
      type: object
      properties:
        links:
          type: array
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
        count:
          type: integer
          description: Total number
          format: int64
    RestPersonalizedAttachmentUpload:
      type: object
      properties:
        uploadedFiles:
          type: array
          description: List of uploaded attachments
          items:
            $ref: '#/components/schemas/RestPersonalizedAttachment'
        token:
          type: string
          description: Personalized attachment token for all files uploaded - can be used when sending transactional mailings
    AttachmentRequestData:
      type: object
      properties:
        name:
          type: string
          description: Attachment name
        fileName:
          type: string
          description: File name of the attachment
        mimeType:
          type: string
          description: Mime type of the attachment
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true