openapi: 3.0.3
info:
title: Benchmark Email RESTful API v3.0 ABTest Creation Agency Account 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: Agency Account
description: Manage linked agency accounts
paths:
/Client/LinkAccount/:
post:
tags:
- Agency Account
summary: Link Account
operationId: post__client_linkaccount
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "
Link Account
\nQuery string parameters : None
\n\nRequest Body parameters:\n\n \n \n | Parameter | \n Required | \n Type | \n Description | \n
\n \n \n \n | Login | \n Required | \n string | \n Login ID | \n
\n \n | Password | \n Required | \n string | \n From Email Address | \n
\n \n "
requestBody:
content:
application/json:
schema:
type: object
/Client/LinkAccount:
get:
tags:
- Agency Account
summary: Get list of link accounts
operationId: get__client_linkaccount
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "Get list of link accounts
\nQuery string parameters : None
\n\nRequest Body parameters: None
\n\nResponse body parameters :\n\n \n \n | Parameter | \n Type | \n Description | \n
\n \n \n \n | Count | \n string | \n Number of link accounts | \n
\n \n | Data | \n Delete Link Account\nQuery string parameters : None\n\nRequest Body parameters:\n\n \n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | ID | \n Required | \n string | \n Link Account ID | \n \n \n \n\nResponse body parameters :\n\n \n \n | Parameter | \n Type | \n "
patch:
tags:
- Agency Account
summary: Update Link Account
operationId: patch__client_linkaccount__id
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: "Update Link Account\nQuery string parameters : None \n\nRequest Body parameters:\n\n \n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | ID | \n Required | \n string | \n Link Account ID | \n \n \n | Login | \n Required | \n string | \n Login ID | \n \n \n Get Link Account Details\nQuery string parameters : None\n\nRequest Body parameters:\n\n \n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | ID | \n Required | \n string | \n Link Account ID | \n \n \n \n\nResponse body parameters :\n\n \n \n | Parameter | \n Type | \n"
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: AuthToken
description: API token obtained from https://ui.benchmarkemail.com/Integrate#API
|