OpenAPI Specification
openapi: 3.0.3
info:
title: Benchmark Email RESTful API v3.0 ABTest Creation Survey API
description: 'RESTful API for managing email marketing contacts, lists, campaigns, automations, reports, images, and webhooks within the Benchmark Email platform. To use the API, you need a Benchmark Email API token available at https://ui.benchmarkemail.com/Integrate#API. Rate limit: 500 calls per 2 minutes and 60,000 calls per day.'
version: 3.0.0
contact:
name: Benchmark Email Developer Support
url: https://developer.benchmarkemail.com/
license:
name: Proprietary
servers:
- url: https://clientapi.benchmarkemail.com
description: Benchmark Email Client API
security:
- apiKeyAuth: []
tags:
- name: Survey
description: Survey
paths:
/Survey:
post:
tags:
- Survey
summary: Create a Survey
operationId: post__survey
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "<h4>Create a Survey</h4>\n<b>Query String Parameters : </b> None <br>\n<b>Request Body Parameters : </b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>Data</td>\n <td>Required</td>\n <td><a href=\"http://www.benchmarkemail.com/models.htm#SurveyData\" >SurveyData</a></td>\n <td>Array of survey data post.</td>\n </tr>\n </tbody>\n</table>\n<b>Response Body Paramete"
requestBody:
content:
application/json:
schema:
type: object
/Survey/{ID}/CopyTemplate:
post:
tags:
- Survey
summary: Use template for Survey
operationId: post__survey__id__copytemplate
parameters:
- name: ID
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "<h4>Copy template in Survey</h4>\n<b>Query string parameters : </b> None <br>\n<b>Request Body Parameters : </b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n <td>string</td>\n <td>Survey ID</td>\n </tr>\n <tr>\n <td>Name</td>\n <td>Required</td>\n <td>string</td>\n <td>Survey name</td>\n </tr>\n </tbody>\n</ta"
requestBody:
content:
application/json:
schema:
type: object
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: AuthToken
description: API token obtained from https://ui.benchmarkemail.com/Integrate#API