openapi: 3.0.3
info:
title: Benchmark Email RESTful API v3.0 ABTest Creation Help 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: Help
description: Help desk and support tickets
paths:
/Help/:
get:
tags:
- Help
summary: Get List of Help Topic
operationId: get__help
parameters:
- name: Filter[URL]
in: query
required: false
schema:
type: string
- name: PageNumber
in: query
required: false
schema:
type: string
- name: PageSize
in: query
required: false
schema:
type: string
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "
Get List of Help Topic
\nQuery string parameters : \n\n \n \n | Parameter | \n Required | \n Type | \n Description | \n
\n \n \n \n | Filter[URL] | \n Required | \n String | \n URL | \n
\n \n | PageNumber | \n Required | \n String | \n Page Number | \n
\n \n | PageSize | \n Required"
post:
tags:
- Help
summary: ' Email Support/feedback to support'
operationId: post__help
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: " Email Support/feedback to support\n\nBody Parameters (to be encoded as a JSON string)\n\n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n | Subject | \n Required | \n string | \n Subject | \n \n \n | Message | \n Required | \n string | \n Your Message | \n \n \n | Name | \n Required | \n string | \n Name of "
requestBody:
content:
application/json:
schema:
type: object
/Help/Ticket:
post:
tags:
- Help
summary: Generate Ticket
operationId: post__help_ticket
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "Generate Ticket\n\nBody Parameters (to be encoded as a JSON string)\n\n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n | Name | \n Required | \n string | \n Name of a poll to be created | \n \n \n\nResponse body parameters\n\n\n\n| Key | Type | Description | \n\n\n| Error | | | |